江苏龙网

  1. 主页 > 生活百科 > >

API文档汇总管理工具Swagger Butler

Swagger Butl

Swagger Butler是一个基于Swagger与Zuul构建的API文档汇集工具 。通过构建一个简单的Spring Boot应用，增加一些配置就能将现有整合了Swagger的Web应用的API文档都汇总到一起，方便查看与测试 。
项目地址

  • Github：https://github.com/dyc87112/swagger-butler
  • Gitee：https://gitee.com/didispace/swagger-butler
使用手册快速入门
该工具的时候非常简单，先通过下面几步简单入门：
第一步：构建一个基础的Spring Boot应用
如您还不知道如何创建Spring Boot应用，可以先阅读本篇入门文章
第二步：在pom.xml中引入依赖
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.10.RELEASE</version></parent><dependencies> <dependency> <groupId>com.didispace</groupId> <artifactId>swagger-butler-core</artifactId> <version>1.0.0</version> </dependency></dependencies>第三步：创建应用主类，增加@EnableSwaggerButler注解开启Swagger Butler功能
@EnableSwaggerButler@SpringBootApplicationpublic class StaticApplication { public static void main(String[] args) { SpringApplication.run(StaticApplication.class); }}第四步：配置文件中增加Swagger文档的地址配置
spring.application.name=swagger-butler-example-staticserver.port=11000zuul.routes.service-a.path=/service-a/**zuul.routes.service-a.url=http://localhost:10010/swagger.butler.resources[0].name=service-aswagger.butler.resources[0].url=/service-a/v2/api-docsswagger.butler.resources[0].swagger-version=2.0zuul.routes.service-b.path=/service-b/**zuul.routes.service-b.url=http://localhost:10020/swagger.butler.resources[1].name=service-bswagger.butler.resources[1].url=/service-b/v2/api-docsswagger.butler.resources[1].swagger-version=2.0上面配置了两个文档位置，由于这里还没有引入服务发现机制，所以需要先用zuul来配置访问本应用请求被转发到具体服务的路由规则 。然后在配置resource信息指向具体的获取swagger的json配置文档的接口链接 。
第五步：访问http://localhost:11000/swagger-ui.html
API文档汇总管理工具Swagger Butler

文章插图
 
Example
代码示例具体可见swagger-butler-example-static目录
原理可见：Spring Cloud Zuul中使用Swagger汇总API接口文档
与eureka整合
在整合eureka获取所有该注册中心下的API文档时，只需要在上面工程的基础上增加下面的配置：
第一步：pom.xml中增加eureka依赖，比如：
<dependencies> <dependency> <groupId>com.didispace</groupId> <artifactId>swagger-butler-core</artifactId> <version>1.0.0</version> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-eureka</artifactId> <version>1.3.2.RELEASE</version> </dependency></dependencies>第二步：应用主类增加@EnableDiscoveryClient，比如：
@EnableDiscoveryClient@EnableSwaggerButler@SpringBootApplicationpublic class EurekaApplication { public static void main(String[] args) { SpringApplication.run(EurekaApplication.class); }}第三步：配置文件中增加eureka的配置，比如：
spring.application.name=swagger-butler-example-eurekaserver.port=11001eureka.client.service-url.defaultZone=http://eureka.didispace.com/eureka/
代码示例具体可见swagger-butler-example-eureka目录
与consul整合
在整合eureka获取所有该注册中心下的API文档时，只需要在上面工程的基础上增加下面的配置：
第一步：pom.xml中增加consul依赖，比如：
<dependencies> <dependency> <groupId>com.didispace</groupId> <artifactId>swagger-butler-core</artifactId> <version>1.0.0</version> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-consul-discovery</artifactId> <version>1.3.2.RELEASE</version> </dependency></dependencies>第二步：应用主类增加@EnableDiscoveryClient，比如：
@EnableDiscoveryClient@EnableSwaggerButler@SpringBootApplicationpublic class EurekaApplication { public static void main(String[] args) { SpringApplication.run(EurekaApplication.class); }}第三步：配置文件中增加eureka的配置，比如：
spring.application.name=swagger-butler-example-consulserver.port=11002spring.cloud.consul.host=localhostspring.cloud.consul.port=8500
代码示例具体可见swagger-butler-example-consul目录

【API文档汇总管理工具Swagger Butler】


推荐阅读


上一篇：SEO优化师，不会告诉你的谷歌搜索引擎规则

下一篇：一文搞懂 Java 线程中断