- Spring Boot+Spring Cloud+Vue+Element項目實戰:手把手教你開發權限管理系統
- 徐麗健
- 346字
- 2019-11-22 18:32:56
第6章 集成Swagger文檔
Spring Boot作為當前最為流行的Java Web開發腳手架,越來越多的開發者選擇用其來構建企業級的RESTFul API接口。這些接口不但會服務于傳統的Web端(B/S),也會服務于移動端。在實際開發過程中,這些接口還要提供給開發測試進行相關的白盒測試,那么勢必存在如何在多人協作中共享和及時更新API開發接口文檔的問題。假如你已經對傳統的WIKI文檔共享方式所帶來的弊端深惡痛絕,那么不妨嘗試一下Swagger2方式,一定會讓你有不一樣的開發體驗。
使用Swagger集成文檔具有以下幾個優勢:
- 功能豐富:支持多種注解,自動生成接口文檔界面,支持在界面測試API接口功能。
- 及時更新:開發過程中花一點寫注釋的時間,就可以及時地更新API文檔,省心省力。
- 整合簡單:通過添加pom依賴和簡單配置,內嵌于應用中就可同時發布API接口文檔界面,不需要部署獨立服務。
官方網站:https://swagger.io/
官方文檔:https://swagger.io/docs/