@ApiModelProperty 是 Swagger 的注解之一,用于在生成的 API 文档中定义和描述接口的属性信息。
在使用 @ApiModelProperty 注解时,你可以在属性上方添加该注解,指定属性的描述、数据类型、是否必需等信息。以下是一个示例:
public class User {
@ApiModelProperty(value = "用户ID", example = "123")
private int id;
@ApiModelProperty(value = "用户名", required = true, example = "John")
private String username;
@ApiModelProperty(value = "用户年龄", example = "25")
private int age;
// 省略其他属性和方法
}
在上面的示例中,通过 @ApiModelProperty 注解为 User 类的属性添加了描述信息。例如,id 属性被描述为 “用户ID”,username 属性被描述为 “用户名”,age 属性被描述为 “用户年龄”。同时,example 参数用于提供属性的示例值。