自问自答
问:@Operation
注解来自哪里?
答:@Operation
是 OpenAPI(Swagger)规范中,来自 io.swagger.v3.oas.annotations
包的一个注解,用于给 REST 接口增加文档元数据。
问:summary
参数是什么?
答:
- 含义:接口的一句话概览,用于简要说明该 API 的主要功能。
- 作用:在生成的 Swagger UI 或 OpenAPI 文档里,作为列表页或接口卡片的标题,帮助用户快速了解此接口做什么。
问:description
参数又是什么?
答:
- 含义:接口的详细描述,可以补充更多信息,比如业务场景、请求示例、特殊注意事项等。
- 作用:在 Swagger UI 的"详细信息"区域展示,帮助使用者更深入地理解该接口的用途或注意点。
问:除了 summary
和 description
,@Operation
还有哪些常用属性?
答:
tags
:给接口打标签,用于分组展示。parameters
:对单个请求参数进行更细粒度的文档描述。responses
:定义返回码、返回类型及其示例。security
:描述接口的安全要求(如需要 OAuth2、API Key 等)。

小结
给接口打上 @Operation(summary, description)
后,Swagger/OpenAPI 工具可以自动读取这些元信息并生成可视化文档,让 API 的使用者一目了然、快速上手。