swagger2 注解整体说明

1@Api：用在请求的类上，表示对类的说明
2 2     tags="说明该类的作用，可以在UI界面上看到的注解"
3 3     value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
4 4 
5 5 @ApiOperation：用在请求的方法上，说明方法的用途、作用
6 6     value="说明方法的用途、作用"
7 7     notes="方法的备注说明"
8 8 
9 9 @ApiImplicitParams：用在请求的方法上，表示一组参数说明
1010     @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
1111         name：参数名
1212         value：参数的汉字说明、解释
1313         required：参数是否必须传
1414         paramType：参数放在哪个地方
1515             · header --> 请求参数的获取：@RequestHeader
1616             · query --> 请求参数的获取：@RequestParam
1717             · path（用于restful接口）--> 请求参数的获取：@PathVariable
1818             · body（不常用）
1919             · form（不常用）    
2020         dataType：参数类型，默认String，其它值dataType="Integer"       
2121         defaultValue：参数的默认值
2222 
2323 @ApiResponses：用在请求的方法上，表示一组响应
2424     @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
2525         code：数字，例如400
2626         message：信息，例如"请求参数没填好"
2727         response：抛出异常的类
2828 
2929 @ApiModel：用于响应类上，表示一个返回响应数据的信息
3030             （这种一般用在post创建的时候，使用@RequestBody这样的场景，
3131             请求参数无法使用@ApiImplicitParam注解进行描述的时候）
3232     @ApiModelProperty：用在属性上，描述响应类的属性

1. @Api：用在请求的类上，说明该类的作用

11 @Api：用在请求的类上，说明该类的作用
22     tags="说明该类的作用"
33     value="该参数没什么意义，所以不需要配置"

示例:

1   @Api(tags="APP用户注册Controller")

2. @ApiOperation：用在请求的方法上，说明方法的作用

11 @ApiOperation："用在请求的方法上，说明方法的作用"
22     value="说明方法的作用"
33     notes="方法的备注说明"

示例:

1  @ApiOperation(value="用户注册",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")

3. @ApiImplicitParams：用在请求的方法上，包含一组参数说明

11 @ApiImplicitParams：用在请求的方法上，包含一组参数说明
2 2     @ApiImplicitParam：用在 @ApiImplicitParams 注解中，指定一个请求参数的配置信息       
3 3         name：参数名
4 4         value：参数的汉字说明、解释
5 5         required：参数是否必须传
6 6         paramType：参数放在哪个地方
7 7             · header --> 请求参数的获取：@RequestHeader
8 8             · query --> 请求参数的获取：@RequestParam
9 9             · path（用于restful接口）--> 请求参数的获取：@PathVariable
1010             · body（不常用）
1111             · form（不常用）    
1212         dataType：参数类型，默认String，其它值dataType="Integer"       
1313         defaultValue：参数的默认值

示例：

1@ApiImplicitParams({
2    @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
3    @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
4    @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
5})

4. @ApiResponses：用于请求的方法上，表示一组响应

11 @ApiResponses：用于请求的方法上，表示一组响应
22     @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
33         code：数字，例如400
44         message：信息，例如"请求参数没填好"
55         response：抛出异常的类

示例：

11 @ApiOperation(value = "select1请求",notes = "多个参数，多种的查询参数类型")
22 @ApiResponses({
33     @ApiResponse(code=400,message="请求参数没填好"),
44     @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
55 })

5. @ApiModel：用于响应类上，表示一个返回响应数据的信息

11 @ApiModel：用于响应类上，表示一个返回响应数据的信息
22             （这种一般用在post创建的时候，使用@RequestBody这样的场景，
33             请求参数无法使用@ApiImplicitParam注解进行描述的时候）
44     @ApiModelProperty：用在属性上，描述响应类的属性

示例：

11 import io.swagger.annotations.ApiModel;
2 2 import io.swagger.annotations.ApiModelProperty;
3 3 
4 4 import java.io.Serializable;
5 5 
6 6 @ApiModel(description= "返回响应数据")
7 7 public class RestMessage implements Serializable{
8 8 
9 9     @ApiModelProperty(value = "是否成功")
1010     private boolean success=true;
1111     @ApiModelProperty(value = "返回对象")
1212     private Object data;
1313     @ApiModelProperty(value = "错误编号")
1414     private Integer errCode;
1515     @ApiModelProperty(value = "错误信息")
1616     private String message;
1717 
1818     /* getter/setter */
1919 }

该文章全篇转载自：https://www.cnblogs.com/jstarseven/p/11458919.html，如有侵权，请联系删除