SpringBoot（七）：SpringBoot整合Swagger2

 原文地址：https://blog.csdn.net/saytime/article/details/74937664

手寫Api文檔的幾個痛點：

1. 文檔須要更新的時候，須要再次發送一份給前端，也就是文檔更新交流不及時。
2. 接口返回結果不明確
3. 不能直接在線測試接口，一般須要使用工具，好比postman
4. 接口文檔太多，很差管理

Swagger也就是爲了解決這個問題，固然也不能說Swagger就必定是完美的，固然也有缺點，最明顯的就是代碼移入性比較強。

其餘的很少說，想要了解Swagger的，能夠去Swagger官網，能夠直接使用Swagger editor編寫接口文檔，固然咱們這裏講解的是SpringBoot整合Swagger2，直接生成接口文檔的方式。

1、依賴

2、Swagger配置類

其實這個配置類，只要瞭解具體能配置哪些東西就行了，畢竟這個東西配置一次以後就不用再動了。 特別要注意的是裏面配置了api文件也就是controller包的路徑，否則生成的文檔掃描不到接口。

Application.class 加上註解@EnableSwagger2 表示開啓Swagger

3、Restful 接口

Json格式輸出類 JsonResult.class

實體User.class

項目結構：

4、Swagger2文檔

啓動SpringBoot項目，訪問 http://localhost:8080/swagger-ui.html

具體裏面的內容以及接口測試，應該一看就懂了。這裏就不一一截圖了。

5、Swagger註解

swagger經過註解代表該接口會生成文檔，包括接口名、請求方法、參數、返回信息的等等。

• @Api：修飾整個類，描述Controller的做用
• @ApiOperation：描述一個類的一個方法，或者說一個接口
• @ApiParam：單個參數描述
• @ApiModel：用對象來接收參數
• @ApiProperty：用對象接收參數時，描述對象的一個字段
• @ApiResponse：HTTP響應其中1個描述
• @ApiResponses：HTTP響應總體描述
• @ApiIgnore：使用該註解忽略這個API
• @ApiError ：發生錯誤返回的信息
• @ApiImplicitParam：一個請求參數
• @ApiImplicitParams：多個請求參數