Swagger在线文档美化_进阶_微服务_网关整合版_v1.0.0

文件名称 版本号 作者 qq 版本
Swagger在线文档美化_进阶_微服务_网关整合版 v1.0.0 学生宫布 8416837 knife4j RELEASE
Swagger 2.9.2
SpringBoot 2.2.6
SpringCloud Hoxton.SR4

成功的美化配置 O(∩_∩)O~↓

使用knife4j文档框架 先看看效果

  • 访问地址是:http://localhost:8080/doc.html
  • http://localhost:8080是整合微服务的模块的地址,一般用网关整合
  • 新的UI,和原版样式不一样了,好像功能也多了,因为Swagger的原理是提供后台数据,页面进行渲染,因此只要调Swagger的功能接口(http://localhost:8080/微服务路由/v2/api-docs),即可获得数据。
    在这里插入图片描述

有靓丽的外表,且功能也挺好

测试接口试一下 成功

在这里插入图片描述

还有下载MD文档等功能
配置步骤 很简单

1)分别在网关和其它微服务引入xml依赖:

  • 在网关引入
<!--        knife4j Swagger-ui 美化-->
        <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>
  • 在其它微服务引入:
		<!--        Swagger 美化-->
        <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
原页面整合了网关同注册中心下面的微服务:
在这里插入图片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章