@ApiModel和@ApiModelProperty
时间: 2023-11-16 07:53:26 浏览: 93
swagger @ApiModel 返回内容注释不显示问题
@ApiModel和@ApiModelProperty是Java中用于API文档生成的注解。
@ApiModel注解用于定义一个API模型,它可以用在类上或者接口上。通过使用@ApiModel注解,我们可以为API模型添加一些描述信息,比如名称、描述等。
@ApiModelProperty注解用于定义API模型的属性,它可以用在类的字段上。通过使用@ApiModelProperty注解,我们可以为API模型的属性添加一些描述信息,比如名称、描述、数据类型等。
例如,我们有一个User类表示用户信息,我们可以使用@ApiModel注解为User类添加一个描述信息,然后使用@ApiModelProperty注解为User类的属性添加一些描述信息。
```java
@ApiModel(description = "用户信息")
public class User {
@ApiModelProperty(value = "用户ID", example = "1")
private Long id;
@ApiModelProperty(value = "用户名", example = "john")
private String username;
}
```
阅读全文