Swagger2 最全注解说明（转载）

转自： Swagger2 最全注解说明 - h3399

Swagger2 最全注解说明

文章目录

1,swagger2 注解整体说明

2,@API: 请求类的说明

3,@ApiOperation: 方法的说明

3.1,@ApiImplicitParams,@ApiImplicitParam: 方法参数的说明

4,@ApiResponses,@ApiResponse: 方法返回值的说明

5,@ApiModel: 用于 JavaBean 上面, 表示一个 JavaBean(如: 响应数据) 的信息

5.1,@ApiModelProperty: 用在 JavaBean 类的属性上面, 说明属性的含义

1,swagger2 注解整体说明

用于 controller 类上:

注解	说明
@Api	对请求类的说明

用于方法上面 (说明参数的含义):

注解	说明
@ApiOperation	方法的说明
@ApiImplicitParams、@ApiImplicitParam	方法的参数的说明；@ApiImplicitParams 用于指定单个参数的说明

用于方法上面 (返回参数或对象的说明):

注解	说明
@ApiResponses、@ApiResponse	方法返回值的说明 ；@ApiResponses 用于指定单个参数的说明

对象类:

注解	说明
@ApiModel	用在 JavaBean 类上，说明 JavaBean 的 用途
@ApiModelProperty	用在 JavaBean 类的属性上面，说明此属性的的含议

2,@API: 请求类的说明

@API: 放在 请求的类上, 与 @Controller 并列, 说明类的作用, 如用户模块, 订单类等.

1. tags="说明该类的作用"
2. value="该参数没什么意义, 所以不需要配置"

示例:

1. @API(tags="订单模块")
2. @Controller
3. public class OrderController {
5. }

@API 其它属性配置:

属性名称	备注
value	url 的路径值
tags	如果设置这个值、value 的值会被覆盖
description	对 api 资源的描述
basePath	基本路径

position	如果配置多个 Api 想改变显示的顺序位置
produces	如, “application/json, application/xml”
consumes	如, “application/json, application/xml”

protocols	协议类型，如: http, https, ws, wss.
authorizations	高级特性认证时配置
hidden	配置为 true ，将在文档中隐藏

3,@ApiOperation: 方法的说明

1. @ApiOperation:"用在请求的方法上, 说明方法的作用"
2. value="说明方法的作用"
3. notes="方法的备注说明"

3.1,@ApiImplicitParams,@ApiImplicitParam: 方法参数的说明

@ApiImplicitParams: 用在请求的方法上, 包含一组参数说明

@ApiImplicitParam: 对单个参数的说明

name: 参数名

value: 参数的汉字说明, 解释

required: 参数是否必须传

paramType: 参数放在哪个地方

. header --> 请求参数的获取:@RequestHeader

. query --> 请求参数的获取:@RequestParam

. path(用于 restful 接口)--> 请求参数的获取:@PathVariable

1. . body(请求体)--> @RequestBody User user
2. . form(普通表单提交)

dataType: 参数类型, 默认 String, 其它值 dataType="Integer"

defaultValue: 参数的默认值

示列:

1. @API(tags="用户模块")
2. @Controller
3. public class UserController {
4. @ApiOperation(value="用户登录",notes="随边说点啥")
5. @ApiImplicitParams({
6. @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
7. @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
8. @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
9. })
10. @PostMapping("/login")
11. public JsonResult login(@RequestParam String mobile, @RequestParam String password,
12. @RequestParam Integer age){
13. //...
14. return JsonResult.ok(map);
15. }
16. }

4,@ApiResponses,@ApiResponse: 方法返回值的说明

@ApiResponses: 方法返回对象的说明

@ApiResponse: 每个参数的说明

code: 数字, 例如 400

message: 信息, 例如 "请求参数没填好"

response: 抛出异常的类

示例:

1. @API(tags="用户模块")
2. @Controller
3. public class UserController {
4. @ApiOperation("获取用户信息")
5. @ApiImplicitParams({
6. @ApiImplicitParam(paramType="query", name="userId", dataType="String", required=true, value="用户 Id")
7. })
8. @ApiResponses({
9. @ApiResponse(code = 400, message = "请求参数没填好"),
10. @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对")
11. })
12. @ResponseBody
13. @RequestMapping("/list")
14. public JsonResult list(@RequestParam String userId) {
15. ...
16. return JsonResult.ok().put("page", pageUtil);
17. }
18. }

5,@ApiModel: 用于 JavaBean 上面, 表示一个 JavaBean(如: 响应数据) 的信息

@ApiModel: 用于 JavaBean 的类上面, 表示此 JavaBean 整体的信息

(这种一般用在 post 创建的时候, 使用 @RequestBody 这样的场景,

请求参数无法使用 @ApiImplicitParam 注解进行描述的时候 )

5.1,@ApiModelProperty: 用在 JavaBean 类的属性上面, 说明属性的含义

示例:

1. @ApiModel(description= "返回响应数据")
2. public class RestMessage implements Serializable{
3. @ApiModelProperty(value = "是否成功")
4. private boolean success=true;
5. @ApiModelProperty(value = "返回对象")
6. private Object data;
7. @ApiModelProperty(value = "错误编号")
8. private Integer errCode;
9. @ApiModelProperty(value = "错误信息")
10. private String message;
11. /* getter/setter 略 */
12. }

来源: http://www.bubuko.com/infodetail-3289545.html