集成之前,我們需要先了解什麼Swagger2?Swagger2是幹什麼用的?
在Web開發時,相信無論是前端還是後端開發或多或少地被接口文檔折磨過。前端經常抱怨後臺給的接口和實際接口對應不上,對於後臺來講,編寫接口文檔實際上就是個費力費神的工作。所以Swagger2就出來了。它可以方便後臺編寫接口文檔,並提供界面測試。
首先,默認我們已經使用Maven環境搭建好Springboot項目。然後我們需要下載Swagger2的依賴包
下載完依賴包後,我們需要Swagger的配置類
在與spring boot集成時,放在與SpringbootApplication.java同級的目錄下。通過@Configuration註解,讓Spring來加載該類配置。
配置完怎麼使用呢?創建測試Controller類
Swagger主要涉及的標籤有:
@Api:主要作用於類上,標識這個類是Swagger的資源
@ApiOperation:主要作用於方法,http請求方式,以及接口訪問地址
@ApiParam():主要作用於方法,請求參數類型,以及參數是否必傳
啟動Springboot後,訪問http://localhost:8080/swagger-ui.html
還可以Try it out下,相當於請求一次接口...
閱讀更多 JAVA君 的文章