【Swagger】Swagger2和Swagger3使用API文档的可视化工具(xiaoymin)

Swagger时接口文档生成工具,在前后端分离时代很好用。不过,当接口多了,看起来不太符合国人的习惯。因为:

  • 缺乏搜索功能
  • 接口类多起来,找接口有如大海捞针。
  • 接口边上,没有带着接口注释
  • 看Model,需要拖拽到最后,没有很自然的切换。

  所以,xiaoymin在swagger的基础上,做到了更好的可视化。

访问地址: ip:端口/doc.html 

Swagger2使用 xiaoymin

pom.xml引用依赖:

1  <dependency>
2     <groupId>com.github.xiaoymin</groupId>
3     <artifactId>swagger-bootstrap-ui</artifactId>
4     <version>${xiaoymin.version}</version>
5 </dependency>

Swagger3使用xiaoymin

pom.xml引用依赖

1 <!--swagger的ui 前身是swagger-bootstrap-ui-->
2 <dependency>
3     <groupId>com.github.xiaoymin</groupId>
4     <artifactId>knife4j-spring-boot-starter</artifactId>
5     <version>3.0.2</version>
6 </dependency>

配置文件application.properties开启doc.html视图

1 springfox.documentation.enabled=true
2 knife4j.basic.enable=true

 

posted @ 2024-10-29 16:45  陆陆无为而治者  阅读(20)  评论(0编辑  收藏  举报