Swagger 常用注解

swagger官网地址：https://swagger.io/

常用注解： 
- @Api()用于类； 
标识这个类是swagger的资源
tags - 表示说明 
value - 也是说明，可以使用tags替代 但是tags如果有多个值，会生成多个list 
description - 注释说明这个类 
- @ApiOperation()用于方法； 表示一个http请求的操作 
value - 字段说明 
notes - 注释说明 
httpMethod - 说明这个方法被请求的方式 
response - 方法的返回值的类型 
- @ApiParam()用于方法，字段说明； 表示对参数的添加元数据（说明或是否必填等） 

name - 参数名称
value - 参数的简要说明
defaultValue - 参数默认值
required -  表示属性是否必填，默认为false
- @ApiModel()用在JavaBean类上，说明JavaBean的用途

description - 描述实体的作用 表示对类进行说明，用于参数用实体类接收 
- @ApiModelProperty()用于方法，字段 表示对model属性的说明或者数据操作更改 
value - 字段说明 
name - 重写属性名字 
dataType - 重写属性类型 
required - 是否必填 
example - 举例说明 
hidden - 隐藏 
- @ApiIgnore()用于类，方法，方法参数 表示这个方法或者类被忽略 
- @ApiImplicitParam() 用于方法,表示单独的请求参数 
name - 参数名 
value - 参数说明 
dataType - 数据类型 
paramType - 表示参数放在哪里
    · header 请求参数的获取：@RequestHeader
    · query   请求参数的获取：@RequestParam
    · path（用于restful接口） 请求参数的获取：@PathVariable
    · body（不常用）
    · form（不常用） 
defaultValue="参数的默认值" 
defaultValue - 参数的默认值 
required -  表示参数是否必须传 - 
@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

@Data
@Api(value = "User", description = "用户表")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 用户id
     */
    @ApiModelProperty(name = "userId", value = "用户主键", example = "55b2059d-97ec", notes = "用户主键")
    private String userId;

}

/**
     * 添加用户
     * @param team
     * @return
     */
    @PutMapping("inteam")
    @ApiOperation(value = "添加用户")
    public StatusViewResult insert(@RequestBody User user) {
        int i =userService.insert(user);
        if (i < 1) {
            ResultGenerator.failed(ErrCode.ERR_TYPE_BIZ,"添加失败");
        }
        return ResultGenerator.success();
    }

@PostMapping("inteam")
    @ApiOperation(value = "查询用户(分页)")
    public TableViewResult<User> queryList(
            @ApiParam(value = "页数", required = true) @RequestParam(defaultValue = "1") Integer page,
            @ApiParam(value = "页数", required = true) @RequestParam(defaultValue = "10") Integer limit,
            User user) {
        PageWrapper<User> pageWrapper = userService.queryList(page, limit, user);
        return ResultGenerator.table(pageWrapper.getData(), pageWrapper.getTotal());
    }