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

最新推荐文章于 2024-08-15 17:15:07 发布

学生宫布

最新推荐文章于 2024-08-15 17:15:07 发布

阅读量1.6k

点赞数 1

分类专栏：技术栈-文档文章标签： Swagger 美化 ui 微服务Swagger

本文链接：https://blog.csdn.net/cc007cc009/article/details/107085865

版权

技术栈-文档专栏收录该内容

5 篇文章 0 订阅

订阅专栏

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

成功美化

使用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
原页面整合了网关同注册中心下面的微服务：
在这里插入图片描述

新页面，调接口路径错误，请求不到数据：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>