@ApiModelProperty 什么意思
时间: 2023-07-18 13:43:45 浏览: 45
`@ApiModelProperty` 是Swagger注解中的一个注解,用于描述一个API接口的返回值或者请求参数。通过使用该注解,可以为API文档提供更加详细的描述信息,包括参数名称、参数类型、参数说明等。
`@ApiModelProperty` 注解中的各个参数含义如下:
- value:参数说明
- name:参数名称
- dataType:参数类型
- example:参数示例值
- required:是否必须,默认为false
- hidden:是否隐藏,默认为false
示例代码:
```
@Data
@ApiModel(value = "用户对象", description = "用户信息")
public class User {
@ApiModelProperty(value = "用户ID", example = "1")
private Long id;
@ApiModelProperty(value = "用户名", example = "张三", required = true)
private String name;
@ApiModelProperty(value = "用户年龄", example = "18", dataType = "Integer")
private Integer age;
}
```
以上代码中,`@ApiModelProperty` 注解为模型类 `User` 的属性添加了详细的说明。例如,`@ApiModelProperty(value = "用户名", example = "张三", required = true)` 表示该属性为必填项,参数名称为 `name`,参数类型为字符串。