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