Swagger 注解 @ApiModelProperty 的作用

@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 参数用于提供属性的示例值。

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值