ApiModelProperty
时间: 2023-07-11 20:22:20 浏览: 96
ApiModelProperty是Swagger注解中的一种,用于描述API的请求或响应参数的数据模型的字段。具体来说,ApiModelProperty注解可以用来说明参数的名称、数据类型、描述等信息。
在使用ApiModelProperty注解时,可以设置以下属性:
- value:参数的描述信息;
- name:参数的名称;
- dataType:参数的数据类型;
- example:参数的示例值;
- required:参数是否必填;
- hidden:参数是否隐藏。
例如,以下是一个使用ApiModelProperty注解的示例:
```
public class User {
@ApiModelProperty(value = "用户ID", example = "123", required = true)
private Long id;
@ApiModelProperty(value = "用户姓名", example = "张三", required = true)
private String name;
@ApiModelProperty(value = "用户年龄", example = "18", required = true)
private Integer age;
// ...
}
```
在上面的示例中,ApiModelProperty注解被用来说明User类的三个字段:id、name、age,它们的名称、数据类型、示例值、是否必填等信息都被描述清楚,这可以帮助开发者更好地理解API的请求参数。
阅读全文