Swagger註解

1、相關注解解讀
1. @Api

用在類上,說明該類的做用
@Api(value = "UserController", description = "用戶相關api")
2. @ApiOperation

用在方法上,說明方法的做用
@ApiOperation(value = "查找用戶", notes = "查找用戶", httpMethod = "GET", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
3 @ApiImplicitParams

用在方法上包含一組參數說明
4. @ApiImplicitParam

用在@ApiImplicitParams註解中,指定一個請求參數的各個方面
paramType:參數放在哪一個地方
header–>請求參數的獲取:@RequestHeader
query–>請求參數的獲取:@RequestParam
path(用於restful接口)–>請求參數的獲取:@PathVariable
body(不經常使用)
form(不經常使用)
name:參數名
dataType:參數類型
required:參數是否必須傳
value:參數的意思
defaultValue:參數的默認值api

@ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "惟一id", required = true, dataType = "Long", paramType = "path"), })

5. @ApiResponsesrestful

用於表示一組響應ide

6. @ApiResponsepost

用在@ApiResponses中,通常用於表達一個錯誤的響應信息
code:數字,例如400
message:信息,例如」請求參數沒填好」
response:拋出異常的類ui

@ApiResponses(value = {  
          @ApiResponse(code = 400, message = "No Name Provided")  
  })
7. @ApiModel

描述一個Model的信息(這種通常用在post建立的時候,使用@RequestBody這樣的場景,請求參數沒法使用@ApiImplicitParam註解進行描述的時候)
@ApiModel(value = "用戶實體類")spa

8. @ApiModelProperty

描述一個model的屬性
@ApiModelProperty(value = "登陸用戶")rest

相關文章
相關標籤/搜索