Swagger2註解的介紹

簡介：

swagger2能夠將項目的全部接口在一個UI界面上展現出來，同時代表了這個接口的用途，接口須要的參數是什麼類型參數是否必須，輸入了參數能夠直接測試接口相似postman的功能，會顯示接口請求的狀態碼和返回的數據結構。

優勢：

1. 大大減小先後端的溝通
2. 方便查找和測試接口
3. 提升團隊的開發效率
4. 方便新人瞭解項目

經常使用註解：

swagger2是經過掃描不少的註解來獲取數據幫咱們展現在ui界面上的，下面就介紹下經常使用的註解。

一、@Api()：用在請求的類上，表示對類的說明，也表明了這個類是swagger2的資源

參數：

tags：說明該類的做用，參數是個數組，能夠填多個。
value="該參數沒什麼意義，在UI界面上不顯示，因此不用配置"
description = "用戶基本信息操做"

二、@ApiOperation()：用於方法，表示一個http請求訪問該方法的操做

參數：

value="方法的用途和做用"    
notes="方法的注意事項和備註"    
tags：說明該方法的做用，參數是個數組，能夠填多個。
格式：tags={"做用1","做用2"} 
（在這裏建議不使用這個參數，會使界面看上去有點亂，前兩個經常使用）

三、@ApiModel()：用於響應實體類上，用於說明實體做用

參數：

description="描述實體的做用"

四、@ApiModelProperty：用在屬性上，描述實體類的屬性

參數：

value="用戶名"  描述參數的意義
name="name"    參數的變量名
required=true     參數是否必選

五、@ApiImplicitParams：用在請求的方法上，包含多@ApiImplicitParam

六、@ApiImplicitParam：用於方法，表示單獨的請求參數

參數：

name="參數ming" 
value="參數說明" 
dataType="數據類型" 
paramType="query" 表示參數放在哪裏
    · header 請求參數的獲取：@RequestHeader
    · query   請求參數的獲取：@RequestParam
    · path（用於restful接口） 請求參數的獲取：@PathVariable
    · body（不經常使用）
    · form（不經常使用） 
defaultValue="參數的默認值"
required="true" 表示參數是否必須傳

七、@ApiParam()：用於方法，參數，字段說明 表示對參數的要求和說明

參數：

name="參數名稱"
value="參數的簡要說明"
defaultValue="參數默認值"
required="true" 表示屬性是否必填，默認爲false

八、@ApiResponses：用於請求的方法上，根據響應碼錶示不一樣響應

一個@ApiResponses包含多個@ApiResponse

九、@ApiResponse：用在請求的方法上，表示不一樣的響應

參數：

code="404"    表示響應碼(int型)，可自定義
message="狀態碼對應的響應信息"

十、@ApiIgnore()：用於類或者方法上，不被顯示在頁面上

十一、@Profile({"dev", "test"})：用於配置類上，表示只對開發和測試環境有用