SpringBoot集成Swagger（九）给你的Swagg

发表于

「这是我参与11月更文挑战的第25天，活动详情查看：2021最后一次更文挑战」

相关文章

Java随笔记：Java随笔记

前言

  • 其实讲到这里，关于Swagger基本功能的介绍就结束了。
  • 不知道大家对Swagger的页面是怎么看的？我看起来反正不大舒服。
  • 所以，今天给大家介绍几款Swagger的皮肤！！
  • 皮肤的使用非常简单，只需简单的引入依赖即可。

一、bootstrap-ui

  • 引入依赖：
  • 1
    2
    3
    4
    5
    6
    xml复制代码 <!-- 引入swagger-bootstrap-ui包 /doc.html-->
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>swagger-bootstrap-ui</artifactId>
                <version>1.9.1</version>
            </dependency>

  • 重启项目，访问：http://localhost:8080/doc.html

  • image-20211127182019892.png

  • 以markdown形式展示文档,将文档的请求地址、类型、请求参数、示例、响应参数分层次依次展示,接口文档一目了然,方便开发者对接。

二、swagger-mg-ui

  • 引入依赖：

  • 1
    2
    3
    4
    5
    xml复制代码        <dependency>
                <groupId>com.zyplayer</groupId>
                <artifactId>swagger-mg-ui</artifactId>
                <version>1.0.6</version>
            </dependency>

  • 重启项目，访问：http://127.0.0.1:8080/document.html

  • image-20211127183140495.png

  • ui支持多种树形菜单展示方式，但我觉得所有请求的颜色都是一样的，反而有点让人误导，不是一目了然！！

三、knife4j

  • 引入依赖：

  • 1
    2
    3
    4
    5
    xml复制代码        <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-ui</artifactId>
                <version>2.0.6</version>
            </dependency>

  • 重启项目，访问：http://127.0.0.1:8080/doc.html

  • image-20211127184003573.png
  • 关于这个得多说几句。
  • knife4j 2.0.6及以上版本，Spring Boot的版本必须大于等于2.2.x，且springfox版本要对应；
  • 2.0.6及以上版本，使用@EnableSwagger2WebMvc注解开启，而2.0.6之前版本是使用@EnableSwagger2注解，和swagger-bootstrap-ui是一样的。

总结

  • 其实还有一种皮肤swagger-ui-layer，但是由于此项目已经停止维护，不兼容最新的SpringBoot和Swagger。所以在此就不列举出来了！
  • 上面介绍了三种皮肤，以我的经验看来，最常用的肯定是knife4j，这也是我平常在使用的风格。
  • 大家可以根据自己的喜欢来选择皮肤！
  • 以上都是个人所言，如有不对，欢迎指出。
  • 如果有其他的皮肤，也欢迎大家指出，我会补充上去！
  • Swagger系列到此结束啦~ 明日开新坑！

路漫漫其修远兮，吾必将上下求索~

如果你认为i博主写的不错！写作不易，请点赞、关注、评论给博主一个鼓励吧~hahah

本文转载自: 掘金

开发者博客 – 和开发相关的 这里全都有

0%