举例说明@ApiOperation怎么用
时间: 2023-11-24 21:08:41 浏览: 70
API使用示例
3星 · 编辑精心推荐
@ApiOperation 是一个注解,用于描述 API 接口。它可以在方法上使用,用于给该方法添加一个 API 文档说明。使用该注解可以帮助开发者更好地理解和使用 API 接口。举个例子,我们可以这样使用 @ApiOperation:
```
@ApiOperation(value = "获取用户信息", notes = "根据用户 ID 获取用户信息")
@GetMapping("/user/{id}")
public User getUser(@PathVariable("id") Long id) {
return userService.getUser(id);
}
```
在这个例子中,通过 @ApiOperation 注解,我们给 getUser 方法添加了一个 API 文档说明,描述了该方法的功能和用法。
阅读全文