swaggerapi传递列表(apidoc和swagger)
Swagger Butler是基于Swagger和Zuul构建的API文档聚合工具。 通过构建简单的spring boot APP应用程序,可以添加一些配置,将现有的基于Swagger的web APP应用程序的API文档合并在一起,以便于查看和测试。
项目地址
IT集线器: https://Github.com/DYC 87112/Swagger-Butlergitee:https://Gitee.com/Didi空间/Swagger-Butler
使用手册
快速交换机这个工具非常简单,首先在下一步简单入门。
第1步:构建基本的spring boot APP应用程序
如果您不知道如何创建spring boot APP,请阅读本入门文章
在步骤pom.xml中引入依赖关系
父母
groupid org.spring框架. boot/groupid
artifactidspring -启动-启动-父/子id
版本1.5.10 .版本/版本
/parent
从属关系
从属关系
groupid com.Didi空间/groupid
artifactidswagger -蓝牙-核心/影响id
版本1.0.0 /版本
/从属关系
/从属关系
步骤3 :创建APP应用程序主类,添加@EnableSwaggerButler注释以打开Swagger Butler功能
@EnableSwaggerButler
@SpringBootApplication
公共类静态应用程序
publicstaticvoidmain (字符串[ ]数组) {
spring应用程序. run (静态应用程序.类;
}
}
步骤将Swagger文档的地址结构添加到配置文件中
spring.application.name=swagger-butler -示例静态
服务器端口=11000
zul.routes .服务- a .路径=/服务- a/* *
zul.routes.service-a.URL=http://本地主机336010010 /
swagger.butler .资源[0] .名称=服务- a
sagger.butler .资源[0].URL=/服务- a/V2 /应用程序文档
swagger.butler.resources [0].swagger -版本=2.0
zul.routes .服务- b .路径=/服务- b/* *
zul.routes.service-b.URL=http://本地主机336010020 /
swagger.butler .资源[1] .名称=服务- b
sagger.butler .资源[1].URL=/服务- b/V2 /应用程序文档
swagger.butler.resources [1].swagger -版本=2.0
上面放置了两个文档的位置,但是这里没有引入服务发现机制,因此必须首先使用zuul设置将访问本APP应用程序的请求传输到特定服务的路由选择规则。 然后,设置指向获取swagger的特定json配置文档的接口链接。
步骤5 :访问http://本地主机:11000/swagger-ui.html
样本
代码示例将具体显示swagger-butler-example-static目录
从原理可以看出,在Spring Cloud Zuul中使用Swagger来总结API接口文档
与eureka的集成
如果要集成eureka以检索此注册中心下的所有API文档,只需在上述项目的基础上添加以下配置:
在步骤pom.xml中添加eureka的依赖关系。 示例:
从属关系
从属关系
groupid com.Didi空间/groupid
artifactidswagger -蓝牙-核心/影响id
版本1.0.0 /版本
/从属关系
从属关系
groupid org.spring框架.云/组id
artifactidspring -云-启动器-欧洲/影响id
版本1.3.2 .版本/版本
/从属关系
/从属关系
步骤2 :应用主类添加@EnableDiscoveryClient。 示例:
@EnableDiscoveryClient
@EnableSwaggerButler
@SpringBootApplication
公共类欧洲应用程序
publicstaticvoidmain (字符串[ ]数组) {
spring应用程序. run (欧盟应用程序.类;
}
}
步骤3 :将eureka配置添加到配置文件中,如下所示:
spring.application.name=swagger-butler-example-eureka
服务器端口=11001
eureka .客户端.服务- URL .默认区域=http://Eureka.Didi空间.com/Eureka /
代码示例具体表示swagger-butler-example-eureka目录
与consul集成
如果要集成eureka以检索此注册中心下的所有API文档,只需在上述项目的基础上添加以下配置:
在步骤pom.xml中添加consul依赖关系。 示例:
从属关系
从属关系
groupid com.Didi空间/groupid
artifactidswagger -蓝牙-核心/影响id
版本1.0.0 /版本
/从属关系
从属关系
groupid org.spring框架.云/组id
artifactidspring -云-启动器-控制台-发现/故障id
版本1.3.2 .版本/版本
/从属关系
/从属关系
步骤2 :应用主类添加@EnableDiscoveryClient。 示例:
@EnableDiscoveryClient
@EnableSwaggerButler
@SpringBootApplication
公共类欧洲应用程序
publicstaticvoidmain (字符串[ ]数组) {
spring应用程序. run (欧盟应用程序.类;
}
}
步骤3 :将eureka配置添加到配置文件中,如下所示:
spring.application.name=swagger-butler -示例控制台
服务器端口=11002
spring.cloud.consul.host=本地主机
spring.cloud.consul.port=8500
代码示例具体表示swagger-butler-example-consul目录