文件名称版本号作者qq版本
Swagger在线文档美化_进阶_微服务_网关整合版v1.0.0学生宫布8416837knife4j RELEASESwagger 2.9.2SpringBoot 2.2.6SpringCloud Hoxton.SR4
成功美化
使用knife4j文档框架 先看看效果
访问地址是:http://localhost:8080/doc.htmlhttp://localhost:8080是整合微服务的模块的地址,一般用网关整合新的UI,和原版样式不一样了,好像功能也多了,因为Swagger的原理是提供后台数据,页面进行渲染,因此只要调Swagger的功能接口(http://localhost:8080/微服务路由/v2/api-docs),即可获得数据。
有靓丽的外表,且功能也挺好
测试接口试一下 成功
还有下载MD文档等功能
配置步骤 很简单
1)分别在网关和其它微服务引入xml依赖:
在网关引入
<dependency>
<groupId>com.github.xiaoymin
</groupId>
<artifactId>knife4j-micro-spring-boot-starter
</artifactId>
<version>RELEASE
</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin
</groupId>
<artifactId>knife4j-spring-boot-starter
</artifactId>
<version>RELEASE
</version>
</dependency>
在其它微服务引入:
<dependency>
<groupId>com.github.xiaoymin
</groupId>
<artifactId>knife4j-micro-spring-boot-starter
</artifactId>
<version>RELEASE
</version>
</dependency>
2)启动项目成功。访问:http://localhost:8080/doc.html
其它美化配置
网关聚合微服务Swagger在线文档
配置步骤 节选
在网关引入Maven依赖xml
<dependency>
<groupId>com.github.caspar-chen
</groupId>
<artifactId>swagger-ui-layer
</artifactId>
<version>0.0.2
</version>
</dependency>
版本号:0.0.2,说明很年轻呀
问题
对于微服务来说,接口路由有误,缺少了添加模块的路由路径
访问页面不同了,是独立的新页面:http://localhost:8080/docs.html 原页面是:http://localhost:8080/swagger-ui.html 原页面整合了网关同注册中心下面的微服务:
新页面,调接口路径错误,请求不到数据:ps:好像得改源码,因为这个路径写死了吧。 正确的路径是:
单机版
在原来基础上新增依赖:
<dependency>
<groupId>com.github.xiaoymin
</groupId>
<artifactId>swagger-bootstrap-ui
</artifactId>
<version>1.9.6
</version>
</dependency>
增强型样式:
<dependency>
<groupId>com.github.xiaoymin
</groupId>
<artifactId>knife4j-spring-boot-starter
</artifactId>
<version>2.0.7
</version>
</dependency>
文章目录
成功美化使用knife4j文档框架 先看看效果有靓丽的外表,且功能也挺好测试接口试一下 成功还有下载MD文档等功能配置步骤 很简单
其它美化配置网关聚合微服务Swagger在线文档配置步骤 节选
问题对于微服务来说,接口路由有误,缺少了添加模块的路由路径单机版