springfox

作者 | 柯然（邪影） 背景 Swagger 是一个规范和完整的前端框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 规范也逐渐发展成为了 OpenAPI 规范。 Springfox 是一个集成了 Swagger，基于 Sring MVC/Spring Webflux 实现的一个 Swagger 描述文件生成框架，通过使用它定义的一些描述接口的注解自动生成 Swagger 的描述文件，使 Swagger 能够展示并调用接口。 相信很多人都听说和使用过 Swagger 和 Springfox，这里就不再赘述了。 Dubbo-Admin 中有接口测试功能，但是缺少接口描述的文档，所以该测试功能比较适合接口开发人员用于测试接口。而其他人想要使用该功能就必须先通过接口开发者编写的文档或者其他方式，了解清楚接口信息才能使用该功能测试接口。 Dubbo 这边有没有集合文档展示和测试功能，可以不用写文档就能把接口直接给调用方，类似 Swagger/Springfox 的工具呢？ 之前做过一些调研，找到一些类似的工具： 有些是基于 Springfox 做的，直接一个文本域放 JSON，与目前 Admin 中的测试功能大同小异。 有些是直接基于 Swagger 的 Java 版 OpenApI 规范生成工具做的，能把一些基础数据类型的简单参数作为表单项展示。

作者 | 柯然（邪影） Dubbo-Api-Docs 背景 Swagger 是一个规范和完整的前端框架,用于生成,描述,调用和可视化 RESTful 风格的 Web 服务. Swagger 规范也逐渐发展成为了 OpenAPI 规范. Springfox 是一个集成了Swagger,基于 Sring MVC/Spring Webflux 实现的一个 Swagger 描述文件生成框架,通过使用它定义的 一些描述接口的注解自动生成Swagger的描述文件, 使 Swagger 能够展示并调用接口. 相信很多人都听说和使用过Swagger和Springfox, 这里就不再赘述了. Dubbo-Admin中有接口测试功能,但是缺少接口描述的文档,所以该测试功能比较适合接口开发人员用于测试接口.而其他人想要使用该功能就必须 先通过接口开发者编写的文档或者其他方式了解清楚接口信息才能使用该功能测试接口. Dubbo这边有没有集合文档展示和测试功能,能不用写文档就能把接口直接给调用方,类似Swagger/Springfox的工具呢? 之前做过一些调研,找到一些类似的工具: 有些是基于Springfox做的,直接一个文本域放JSON, 与目前Admin中的测试功能大同小异 有些是直接基于Swagger的Java版OpenApi规范生成工具做的,能把一些基础数据类型的简单参数作为表单项展示

　　本次和大家分享的是java方面的springmvc来构建的webapi接口+swagger文档；上篇文章分享.net的webapi用swagger来构建文档，因为有朋友问了为啥.net有docpage文档你还用swagger，这里主要目的是让接口文档统一，当操作多种开发语言做接口时，如果有统一风格的api文档是不是很不错；还有就springcloude而言，微服务如果有很多的话，使用swagger自动根据服务serverid来加载api文档是很方便的。swagger设置比较简单，为了今后查找资料和使用方便故此记录下 准备工作 快速构建api文档 常用的细节 过滤默认错误api 添加授权token列 添加上传文件列 准备工作 　　首选需要一个springmvc项目，这里我用的是springboot+maven来快速构建， 要使用swagger只需要在maven中添加依赖包就行： 1 <dependency> 2 <groupId>io.springfox</groupId> 3 <artifactId>springfox-swagger2</artifactId> 4 <version> 2.6 . 1 </version> 5 </dependency> 6 <dependency> 7 <groupId>io.springfox</groupId> 8 <artifactId

点击上方蓝色“ 程序猿DD ”，选择“设为星标” 回复“ 资源 ”获取独家整理的学习资料！ 作者 | linkt1234 来源 | https://blog.csdn.net/Linkthaha/article/details/100575278 最近，在对公司容器云的日志方案进行设计的时候，发现主流的ELK或者EFK比较重，再加上现阶段对于ES复杂的搜索功能很多都用不上最终选择了Grafana开源的Loki日志系统，下面介绍下Loki的背景。 背景和动机 当我们的容器云运行的应用或者某个节点出现问题了，解决思路应该如下： 我们的监控使用的是基于prometheus体系进行改造的，prometheus中比较重要的是metric和alert,metric是来说明当前或者历史达到了某个值，alert设置metric达到某个特定的基数触发了告警，但是这些信息明显是不够的。我们都知道，k8s的基本单位是pod,pod把日志输出到stdout和stderr,平时有什么问题我们通常在界面或者通过命令查看相关的日志,举个例子：当我们的某个pod的内存变得很大，触发了我们的alert，这个时候管理员，去页面查询确认是哪个pod有问题，然后要确认pod内存变大的原因，我们还需要去查询pod的日志，如果没有日志系统，那么我们就需要到页面或者使用命令进行查询了： 如果，这个时候应用突然挂了

这是因为Spring整合springfox-swagger2后导致的，错误信息如下： 2019 - 07 - 04 13 : 53 : 07 , 537 [main] [WARN] [org.springframework.context.support.GenericApplicationContext] - Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name ' documentationPluginsBootstrapper ' defined in URL [jar:file:/C:/Users/Administrator/.m2/repository/io/springfox/springfox-spring-web/ 2.7 . 0 /springfox-spring-web- 2.7 . 0 .jar!/springfox/documentation/spring/web/plugins/DocumentationPluginsBootstrapper. class ]

一、Swagger的主要作用有两方面： 1、生成在线文档，通过注解方式生成在线文档，方便在定义修正接口时直接修改接口文档； 2、对接口文档在线测试，不用在输入接口地址以及里面的参数对象，可以很方便的对在线接口测试。 二、 Swagger的使用方法如下： 1、引入springfox-swagger2的jar包依赖 < dependency > < groupId > io.springfox </ groupId > < artifactId > springfox-swagger2 </ artifactId > < version > 2.9.2 </ version > </ dependency > < dependency > < groupId > io.springfox </ groupId > < artifactId > springfox-swagger-ui </ artifactId > < version > 2.9.2 </ version > </ dependency > 2、增加swagger配置文件 @Configuration @EnableSwagger 2 public class SwaggerConfig { /** * 根据配置读取是否开启swagger文档，针对测试与生产环境采用不同的配置 */ @Value ( "$