举例说明springboot接口处写@ApiModelProperty注解
时间: 2023-10-17 22:09:48 浏览: 193
SpringBoot http请求注解@RestController原理解析
@ApiModelProperty注解可以用于控制Swagger文档生成规则,可以在实体类属性上使用。例如:
```
@ApiModel("用户实体类")
public class User {
@ApiModelProperty(value = "用户ID", example = "1")
private Integer id;
@ApiModelProperty(value = "用户名", example = "John")
private String username;
@ApiModelProperty(value = "用户密码", example = "123456")
private String password;
// 省略getter/setter方法
}
```
@ApiModelProperty中的value属性可以设置该属性在Swagger文档中的描述信息,example属性可以设置该属性示例值,方便用户查看和测试。
阅读全文