@ApiModelProperty用法
时间: 2024-01-25 09:12:44 浏览: 84
swagger @ApiModel 返回内容注释不显示问题
@ApiModelProperty是Swagger框架中的注解,用于描述API接口的属性信息。它可以用于类的字段上,用于指定字段的名称、数据类型、是否必填等属性。
下面是一个使用@ApiModelProperty注解的示例:
```java
@ApiModelProperty(value = "主键", name = "id", dataType = "int", required = true)
private int id;```
在上面的示例中,@ApiModelProperty注解用于描述一个名为"id"的字段,它的值是一个整数类型,是必填项。
@ApiModelProperty注解的常用属性包括:
- value:属性的描述信息。
- name:属性的名称。
- dataType:属性的数据类型。
- required:属性是否必填,默认为false。
- example:属性的示例值。
- hidden:属性是否隐藏,默认为false。
通过使用@ApiModelProperty注解,我们可以更好地描述API接口的属性信息,提高接口文档的可读性和准确性。
阅读全文