swagger2 常用注解使用及其说明

1.@Api:用在类上，说明该类的作用。可以标记一个 Controller 类作为 Swagger 文档资源

@RestController
@RequestMapping("/sys")
@Api(tags = "用户模块",description = "用户模块相关接口")
public class UserController {
}

2.@ApiModel :用在类上，表示对类进行说明，用于实体类中的参数接收说明.

@Data
@ApiModel(value = "com.yingxue.lesson.vo.req.UpdateUserReqVO",description = "更新用户")
public class UpdateUserReqVO {
}

 3.@ApiModelProperty:用于字段，表示对 model 属性的说明

@Data
@ApiModel(value = "com.yingxue.lesson.vo.req.UpdateUserReqVO",description = "更新用户参数")
public class UpdateUserReqVO {
    @ApiModelProperty(value = "用户id")
    private String id;
    @ApiModelProperty(value = "账号")
    private String username;
    @ApiModelProperty(value = "密码")
    private String password;
    @ApiModelProperty(value = "手机号")
    private String phone;
    @ApiModelProperty(value = "机构id")
    private String deptId;
    @ApiModelProperty(value = "真实名称")
    private String realName;
    @ApiModelProperty(value = "暱称")
    private String nickName;
    @ApiModelProperty(value = "邮箱")
    private String email;
    @ApiModelProperty(value = "状态")
    private Integer status;
    @ApiModelProperty(value = "性别")
    private Integer sex;
    @ApiModelProperty(value = "涞源")
    private Integer createWhere;
}

4.@ApiResponse和@ApiResponses，用于方法上说明接口响应一些信息。 @ApiResponses表示一组@ApiResponse