斯瓦格巴特勒是一个基于时髦的与Zuul构建的应用程序接口文档汇集工具。通过构建一个简单的Spring Boot应用,增加一些配置就能将现有整合了时髦的的网应用的应用程序接口文档都汇总到一起,方便查看与测试。
项目地址
github:https://github。com/dyc 87112/swag-butler gitee:https://gitee。com/滴滴空间/swag-butler
使用手册
快速入门该工具的时候非常简单,先通过下面几步简单入门:
第一步:构建一个基础的Spring Boot应用
如您还不知道如何创建Spring Boot应用,可以先阅读本篇入门文章
第二步:在pom.xml中引入依赖
父母
groupIdorg.springframework.boot/groupId
artifactIdspring-boot-starter-parent/artifactId
version1.5.10.RELEASE/version
/家长
属国
属国
groupIdcom.didispace/groupId
artifactidswaggle-butler-core/artifactId
版本1 .0 .0/版本
/依赖性
/依赖项
第三步:创建应用主类,增加@EnableSwaggerButler注解开启斯瓦格巴特勒功能
@EnableSwaggerButler
@回弹应用
公共类StaticApplication {
公共静态void main(String[]参数){ 0
springapplication。运行(静态应用程序。类);
}
}
第四步:配置文件中增加时髦的文档的地址配置
春天。应用程序。name=swag-butler-示例-静态
server.port=11000
祖尔。路线。service-a . path=/service-a/* *
祖尔。路线。服务-a . URL=http://localhost :10010/
赃物。巴特勒。资源[0].名称=服务构成动植物的古名或拉丁化的现代名
赃物。巴特勒。资源[0].url=/service-a/v2/api-docs
赃物。巴特勒。资源[0].斯瓦格-版本=2.0
祖尔。路线。service-b . path=/service-b/* *
祖尔。路线。service-b . URL=http://localhost :10020/
招摇。巴特勒。资源[1]。名称=服务-b
招摇。巴特勒。资源[1]。url=/service-b/v2/api-docs
招摇。巴特勒。资源[1]。斯瓦格-版本=2.0
上面配置了两个文档位置,由于这里还没有引入服务发现机制,所以需要先用zuul来配置访问本应用请求被转发到具体服务的路由规则。然后在配置资源信息指向具体的获取时髦的的json配置文档的接口链接。
第五步:访问http://localhost :11000/swag-ui。超文本标记语言
代码示例具体可见霸气-巴特勒-例子-静态目录
原理可见:春云Zuul中使用时髦的汇总应用程序接口接口文档
与尤里卡整合
在整合尤里卡获取所有该注册中心下的应用程序接口文档时,只需要在上面工程的基础上增加下面的配置:
第一步:pom.xml中增加尤里卡依赖,比如:
属国
属国
groupIdcom.didispace/groupId
artifactidswaggle-butler-core/artifactId
版本1 .0 .0/版本
/依赖性
属国
groupIdorg.springframework.cloud/groupId
artifactIdspring-cloud-starter-eureka/artifactId
version1.3.2.RELEASE/version
/依赖性
/依赖项
第二步:应用主类增加@EnableDiscoveryClient,比如:
@EnableDiscoveryClient
@EnableSwaggerButler
@回弹应用
公共类尤里卡应用程序{
公共静态void main(String[]参数){ 0
springapplication。运行(尤里卡应用程序。类);
}
}
第三步:配置文件中增加尤里卡的配置,比如:
春天。应用程序。名称=swag-butler-示例-尤里卡
server.port=11001
尤里卡。客户。服务-网址。DefaultZone=http://ureka。滴滴空间。com/eureka/
代码示例具体可见斯瓦格-巴特勒-范例-尤里卡目录
与领事整合
在整合尤里卡获取所有该注册中心下的应用程序接口文档时,只需要在上面工程的基础上增加下面的配置:
第一步:pom.xml中增加领事依赖,比如:
属国
属国
groupIdcom.didispace/groupId
artifactidswaggle-butler-core/artifactId
版本1 .0 .0/版本
/依赖性
属国
groupIdorg.springframework.cloud/groupId
artifactIdspring-cloud-starter-consult-discovery/artifactId
version1.3.2.RELEASE/version
/依赖性
/依赖项
第二步:应用主类增加@EnableDiscoveryClient,比如:
@EnableDiscoveryClient
@EnableSwaggerButler
@回弹应用
公共类尤里卡应用程序{
公共静态void main(String[]参数){ 0
springapplication。运行(尤里卡应用程序。类);
}
}
第三步:配置文件中增加尤里卡的配置,比如:
春天。应用程序。name=swag-butler-示例-咨询
server.port=11002
春天。云。咨询。host=localhost
春天。云。咨询。端口=8500
代码示例具体可见斯瓦格-巴特勒-榜样-执政官目录
推荐阅读:
春云阿里巴巴到底坑不坑?
说说我为什么看好春云阿里巴巴