SpringBoot2.x系列教程（四十三）SpringBoot整合Swagger2

• 2020 年 3 月 18 日
• 筆記

在上篇文章中我們講解了RESTful的概念及相關風格API的設計，那麼針對多客戶端的API，作為後端開發如何對介面進行驗證呢？當然，可以通過寫單元測試來完成。但如果還需要維護每個介面的API文檔，同時還要保持版本更新維護呢？是不是工作量變得異常繁重了。

那麼，Swagger的出現，可以幫助後端開發人員輕鬆的解決上述痛點。

針對介面的功能測試，你不僅可以通過單元測試來進行驗證，還可以通過Swagger提供的可視化頁面操作來進行操作完成。

針對API文檔，通過Swagger提供的功能，可以系統的管理整個項目的API文檔。

而Swagger又可以輕鬆整合到Spring Boot等項目中，與Spring MVC程式配合組織出強大RESTful API文檔。

減少創建文檔的繁瑣操作，介面描述又整合入程式碼中，讓維護文檔和修改程式碼整合為一體。實現了在修改程式碼邏輯的同時輕鬆修改介面文檔說明。

不僅如此，針對每個介面在頁面上還提供了強大的測試功能，可以針對每一個介面進行測試操作。

效果及示例頁面如下：

Spring Boot集成Swagger2

在Spring Boot中集成Swagger2是非常方便，特別是使用最新版本的Swagger2，只用添加依賴，配置實例化類，即可完成最簡單的介面及API文檔的呈現和使用。

引入依賴

這裡引入當前最新版本的Swagger2的依賴：

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger