api簡介
隨着互聯網技術的發展，現在的網站架構基本都由原來的後端渲染，變成了：前端渲染、先後端分離的形態，而且前端技術和後端技術在各自的道路上越走越遠。
前端和後端的唯一聯繫，變成了API接口；API文檔變成了前後端開發人員聯繫的紐帶，變得越來越重要，swagger就是一款讓你更好的書寫API文檔的框架。 --引用 RyuGou的專欄
swagger 使用
這一欄主要是給會使用和會配置swagger的成員提供一套swagger使用規範，如果是新手，本文後面會加入一整套springboot swagger配置和運行說明。
解讀一個api無非分成：接口列表、接口名稱、協議、參數釋義、mock等。
如果我們把項目分成controller、server、dao、entity的話，那swagger主要作用於controller和entity層。
controller層設置：
類頭註釋 紅色的爲描述不需要真正用在項目中 @Api(value = "/測試接口（中英文都可以）", description = "爲測試環境下的一個demo頁面接口（接口描述一般指某個頁面）-www（接口負責人）", tags={"測試頁面"})
示例：
@Api(value = "/測試接口", description = "爲測試環境下的一個demo頁面接口-www", tags={"測試頁面"})
示圖：
視圖
方法頭註釋 紅色的爲描述不需要真正用在項目中 @ApiOperation(value = "保存按鈕（一般指這個頁面下的某個功能）-wcy（如果類頭上的接口負責人不是你一定要加上這一欄，如果是你可以去掉）") 或者 @ApiOperation(value = "通過id獲取信息")
示例：
@ApiOperation(value = "保存按鈕-www")
entity實體層註釋：
實體類的註解主要是@ApiModelProperty 。
1、如果前端接口不顯示當前字段: @ApiModelProperty(hidden = true)
2、如果需要顯示： @ApiModelProperty(name = "user_id"(字段名), notes = "用戶id"(字段解釋), example = "1"（字段的例子）, required = true（是否必填true必填，false非必填，如果沒有這欄這默認非必填）)
示例
@ApiModelProperty(name = "user_id", notes = "用戶id", example = "1", required = true)
代碼
視圖
爲了給前端更友好的api文檔體驗，項目中會創建vo（顯示對象）、po（接收對象）
例如
其他：
如何搭建springboot+swagger：
swagger 註解總結（包含非實體api文檔的設置）：
https://blog.csdn.net/yilishuku/article/details/81199239