@ApiModelProperty 所有参数用法
时间: 2023-10-17 20:25:51 浏览: 211
@ApiModel是一个可以应用于类上的注解,用于定义API接口中参数的用法。
在使用@ApiModel注解时,可以结合使用@ApiModelProperty注解来详细描述各个参数的用法。@ApiModelProperty注解可以应用于类的属性上,用于描述该属性在API接口中的作用和用途。
下面是一些常见的@ApiModel和@ApiModelProperty的用法示例:
1. 使用@ApiModel注解定义一个接口请求对象或响应对象:
```
@ApiModel(description = "用户对象")
public class User {
@ApiModelProperty(value = "用户ID", example = "123")
private Long id;
@ApiModelProperty(value = "用户名", example = "John")
private String username;
// 省略其他属性和方法
}
```
2. 使用@ApiModelProperty注解描述属性的用法:
```
public class User {
@ApiModelProperty(value = "用户ID", example = "123", required = true)
private Long id;
@ApiModelProperty(value = "用户名", example = "John", required = true)
private String username;
// 省略其他属性和方法
}
```
在上面的示例中,@ApiModelProperty的value属性用于描述参数的作用,example属性用于提供参数的示例值,required属性用于指示参数是否为必需的。
3. 使用@ApiModelProperty注解描述属性的数据类型:
```
public class User {
@ApiModelProperty(value = "用户ID", example = "123", dataType = "java.lang.Long")
private Long id;
@ApiModelProperty(value = "用户名", example = "John", dataType = "java.lang.String")
private String username;
// 省略其他属性和方法
}
```
在上面的示例中,dataType属性用于指定参数的数据类型。这样可以在接口文档中清晰地显示参数的类型信息。
以上是@ApiModel和@ApiModelProperty的一些常见用法,你可以根据实际需要进行灵活应用。