注解說明
| 作用范圍 | API | 使用位置 |
|---|---|---|
| 對象屬性 | @ApiModelProperty | 用在出入?yún)?shù)對象的字段上 |
| 協(xié)議集描述 | @Api | 用于controller類上 |
| 協(xié)議描述 | @ApiOperation | 用在controller的方法上 |
| Response集 | @ApiResponses | 用在controller的方法上 |
| Response | @ApiResponse | 用在 @ApiResponses里邊 |
| 非對象參數(shù)集 | @ApiImplicitParams | 用在controller的方法上 |
| 非對象參數(shù)描述 | @ApiImplicitParam | 用在@ApiImplicitParams的方法里邊 |
| 描述返回對象的意義 | @ApiModel | 用在返回對象類上 |
注解@ApiImplicitParam的paramType參數(shù)使用說明
paramType：表示參數(shù)的類型使用場景說明
| 類型 | 使用說明 | 舉例 |
|---|---|---|
| header | 請求參數(shù)的獲仁取：@RequestHeader(代碼中接收注解) | |
| query | 請求參數(shù)的獲雀贰：@RequestParam(代碼中接收注解)顿苇， | getUser?user =admin |
| path（用于restful接口） | 請求參數(shù)的獲茸忽ā：@PathVariable(代碼中接收注解) | getUser/user/admin |
| body | 請求參數(shù)的獲戎路荨：@RequestBody(代碼中接收注解) | |
| form | （不常用） |
