手把手教你 3 分鐘搞定 SpringBoot 整合 Swagger2
- 2019 年 12 月 20 日
- 筆記
Swagger 又稱絲襪哥,號稱可以讓程式設計師邊寫程式碼邊生產介面文檔。所以,深受光大程式設計師喜愛。目前使用的最多的當屬 Swagger2 和 SpringBoot,所以我這篇文章都以這兩個框架為中心進行展開!
在開始之前,先說一下,昨天群里那位網友的問題。「No operations defined in spec!」,之所以出現這個問題是因為我們在配置 Swagger2 掃描的包時,沒有配置正確。這個問題通過百度,能得到一堆的答案。所以,有時候面向百度編程也是一條捷徑!
如果上面這個影片,你還沒看過癮,沒看懂。那可以繼續看我的這篇文章。
整合的第一步,引入 pom 配置。

整合的第二步,使用 @EnableSwagger2 註解開啟 Swagger2。

@EnableSwagger2 的註解也可以寫在配置類上,二者選其一即可。

至此,兩個框架的整合就完成了。啟動項目,訪問 Swagger2 的 ui 介面,就可以看到介面文檔了。

上面兩個介面,是我通過註解改正了介面的中文名名稱。這樣更方便我們開發和閱讀!

Swagger2 常用的註解不是很多,列舉如下:

更多註解用法建議查看官網文檔,或者通過搜索引擎查找!