@ApiOperation

 Swagger 框架注解

@ApiOperation

@ApiOperation 是 Swagger 框架中的一个注解，用于对控制器中的接口方法进行描述和文档化。通过在接口方法上添加 @ApiOperation 注解，可以为接口方法提供接口名称、描述、参数信息等，方便开发者和后端团队对接口进行理解和使用。

@ApiOperation 主要包含以下参数：

- value：接口方法的简要描述。
- notes：接口方法的详细描述。
- tags：接口方法所属的标签，可以用来对接口进行分类。
- response：接口方法的返回类型。

通过使用 @ApiOperation 注解，可以生成接口文档并展示在 Swagger UI 中，方便开发者查看和测试接口。同时，接口文档的生成也可以帮助前端开发者了解后端接口的使用方式，提高前后端的协作效率。

示例：

```java
@RestController
@RequestMapping("/api")
public class MyController {

@ApiOperation(value = "获取用户信息", notes = "根据用户 ID 获取用户信息", tags = "User")
@GetMapping("/user/{id}")
public User getUserById(@PathVariable Long id) {
// 方法实现
}
}
```

在上面的示例中，通过 @ApiOperation 注解为 getUserById 方法添加了接口描述、详情和标签信息，便于生成接口文档并展示给开发者查看。