swagger注解API详细说明
注解说明
作用范围 | API | 使用位置 |
|---|---|---|
对象属性 | @ApiModelProperty | 用在出入参数对象的字段上 |
协议集描述 | @Api | 用于controller类上 |
协议描述 | @ApiOperation | 用在controller的方法上 |
Response集 | @ApiResponses | 用在controller的方法上 |
Response | @ApiResponse | 用在 @ApiResponses里边 |
非对象参数集 | @ApiImplicitParams | 用在controller的方法上 |
非对象参数描述 | @ApiImplicitParam | 用在@ApiImplicitParams的方法里边 |
描述返回对象的意义 | @ApiModel | 用在返回对象类上 |
注解@ApiImplicitParam的paramType参数使用说明
paramType：表示参数的类型使用场景说明
类型 | 使用说明 | 举例 |
|---|---|---|
header | 请求参数的获取：@RequestHeader(代码中接收注解) | |
query | 请求参数的获取：@RequestParam(代码中接收注解)， | getUser?user =admin |
path（用于restful接口） | 请求参数的获取：@PathVariable(代码中接收注解) | getUser/user/admin |
body | 请求参数的获取：@RequestBody(代码中接收注解) | |
form | （不常用） |
本文参与 腾讯云自媒体分享计划，分享自作者个人站点/博客。
原始发表：2019.10.08 ，如有侵权请联系 cloudcommunity@tencent.com 删除
评论
登录后参与评论
推荐阅读
目录