Swagger常用注解

Swagger常用注解

注：

通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性。

注解

1，用在类上，例如Controller，表示对类的说明

@Api    如：@Api(tags = "员工相关接口")

2，用在类上，例如entity、DTO、VO

@ApiModel    如：@ApiModel(description = "员工登录时传递的数据模型")

3，用在属性上，描述属性信息

@ApiModelProperty    如：@ApiModelProperty("用户名")

4，用在方法上，例如Controller的方法，说明方法的用途、作用

@ApiOperation     如：@ApiOperation(value = "员工登录") 或 @ApiOperation("员工退出")