swagger2常用註解釋義
阿新 • • 發佈:2018-11-13
@Api:用於請求類上,說明類的作用
tags="說明該類的作用,顯示在UI介面上"
value="可不配置"
@ApiOperation:用於請求方法上,說明方法的用途及作用
value="說明方法的用途、作用"
notes="方法的備註說明"
@ApiImplicitParams:用於請求方法上,表示一組引數說明
@ApiImplicitParam:用於@ApiImplicitParams註解中或單獨用於方法上,說明一個請求引數
name:引數名
value:引數的中文說明
required:引數是否必須
paramType:引數位置
· header -- > 請求引數的獲取:@RequestHeader
· query --> 請求引數的獲取:@RequestParam
· path(用於restful介面)--> 請求引數的獲取:@PathVariable
· body(json傳參)
· form(不常用)
dataType:引數型別,預設String
defaultValue:引數的預設值
@ApiResponses:用於請求的方法上,表示一組響應
@ApiResponse:用於@ApiResponses 中或單獨用於方法上,一般用於表達一個錯誤的響應資訊
code:數字,例如400
message:資訊,例如"請求引數沒填好"
response:丟擲異常的類
@ApiModel:用於響應類上,表示一個返回響應資料的資訊
(這種一般用在post建立的時候,使用@RequestBody這樣的場景,
請求引數無法使用@ApiImplicitParam註解進行描述的時候)
@ApiModelProperty:用在屬性上,描述響應類的屬性