@ApiOperation的使用

@ApiOperation 是 Swagger 框架中的一个注解，用于对 API 接口进行描述和文档化。该注解可以应用在方法上，用于描述方法的作用、参数、返回值等信息。

@ApiOperation 的常用属性包括：

- value：方法的简要描述。
- notes：方法的详细描述。
- tags：指定接口所属的标签，用于分类和组织接口。
- response：方法返回的响应信息，可以指定多个响应信息。

使用 @ApiOperation 注解可以提供更加清晰明了的接口文档，并且可以通过 Swagger UI 自动生成接口文档页面。这样，其他开发人员可以更快地了解和使用您的接口。

示例代码：

@RestController
public class UserController {

    @ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户的详细信息")
    @GetMapping("/user/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // ...
    }

    // ...
}

在上述示例中，@ApiOperation 注解被应用在 `getUserById` 方法上，用于描述获取用户信息的接口。其中，`value` 属性指定了接口的简要描述，`notes` 属性指定了接口的详细描述。

希望以上信息对您有所帮助！如果您还有其他问题，请随时提问。