SpringBoot @ApiModelProperty注解
时间: 2023-11-16 12:53:46 浏览: 93
工作中遇到的问题汇总
@ApiModelProperty注解是由Swagger提供的用于描述API接口中属性的注解,通常用于SpringBoot应用中。通过使用该注解,我们可以在生成的API文档中,清晰地展示出每个属性的含义、数据类型、是否必填等信息,使得API文档更加规范、易读。
例如,我们可以在一个DTO类的属性上添加@ApiModelProperty注解,如下所示:
```
public class UserDto {
@ApiModelProperty(value = "用户ID", example = "123")
private Long id;
@ApiModelProperty(value = "用户名称", required = true, example = "张三")
private String name;
//...
}
```
其中,value属性用于描述属性的含义;example属性用于描述属性的示例值;required属性用于标识该属性是否必填。
阅读全文