Swagger中的@ApiModelProperty注解用于描述模型属性的信息,包括属性名称、数据类型、示例值、默认值、是否必需等。
具体用法如下:
- 在模型类的属性上使用@ApiModelProperty注解,指定属性的描述信息。
- 通过value属性指定属性的名称。
- 通过dataType属性指定属性的数据类型。
- 通过example属性指定属性的示例值。
- 通过required属性指定属性是否必需,默认为false。
- 通过defaultValue属性指定属性的默认值。
示例代码如下:
public class User {
@ApiModelProperty(value = "用户ID", dataType = "Long", example = "1")
private Long id;
@ApiModelProperty(value = "用户名", dataType = "String", required = true)
private String username;
@ApiModelProperty(value = "密码", dataType = "String")
private String password;
// getters and setters
}
在上面的示例中,@ApiModelProperty注解分别用于描述User类的id、username和password属性。通过value属性指定属性的名称,dataType属性指定属性的数据类型,example属性指定属性的示例值,required属性指定属性是否必需,默认为false。
这样,在生成Swagger文档时,就可以根据@ApiModelProperty注解的信息来展示模型属性的相关信息。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,请发送邮件至 55@qq.com 举报,一经查实,本站将立刻删除。转转请注明出处:https://www.szhjjp.com/n/850244.html