SpringBoot整合Swagger（九）給你的Swagger換個面板吧 | Java隨筆記

語言: CN / TW / HK
時間 2021-11-27 19:15:25

theme: scrolls-light

「這是我參與11月更文挑戰的第25天，活動詳情檢視：2021最後一次更文挑戰」

相關文章

Java隨筆記：Java隨筆記

前言

  • 其實講到這裡，關於Swagger基本功能的介紹就結束了。
  • 不知道大家對Swagger的頁面是怎麼看的？我看起來反正不大舒服。
  • 所以，今天給大家介紹幾款Swagger的面板！！
  • 面板的使用非常簡單，只需簡單的引入依賴即可。

一、bootstrap-ui

  • 引入依賴：
  • <!-- 引入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

  • 引入依賴：
  • <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

  • 引入依賴：
  • <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

「」
「」