swagger中@ApiParam与@ApiModel的区别
时间: 2023-06-19 09:06:38 浏览: 115
在Swagger中,@ApiParam和@ApiModel都是用于API文档的注解,但是它们的作用略有不同。
@ApiParam注解用于描述API接口中的单个参数,可以包含参数名称、描述、数据类型、是否必填等信息。例如:
```java
@ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "userId", value = "用户ID", dataType = "Long", paramType = "query", required = true)
})
@GetMapping("/user")
public UserDto getUser(@RequestParam Long userId) {
//...
}
```
@ApiModel注解用于描述API接口中的数据模型,即请求或响应对象的数据结构。可以包含模型名称、描述、字段等信息。例如:
```java
@ApiModel("用户信息")
public class UserDto {
@ApiModelProperty(value = "用户ID")
private Long id;
@ApiModelProperty(value = "用户名")
private String name;
// getter/setter...
}
```
总的来说,@ApiParam注解用于描述API接口中的单个参数,@ApiModel注解用于描述API接口中的数据模型。