swagger2 注解说明

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

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

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

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

示例：

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

3、@ApiOperation：用在请求的方法上，说明方法的作用
        value="说明方法的作用"
        notes="方法的备注说明"
示例：

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

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

示例：

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
 
import java.io.Serializable;
 
@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{
 
    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private Object data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;
 
    /* getter/setter */
}