openapi_docs

该技能用于在 Spring Boot 3.x 项目中借助 SpringDoc OpenAPI 3.0 与 Swagger UI 实现 REST API 文档化，适用于 WebMvc 或 WebFlux 应用，也支持 Kotlin 编写的 API。主要能力包括：通过注解（如 @Operation、@ApiResponse、@Tag、@Schema、@Parameter）描述接口、请求体、模型与校验约束；为错误响应与全局异常处理器编写文档；配置 JWT、OAuth2、Basic Auth 等安全方案；用 @ParameterObject 记录 Pageable 分页排序端点；按 GroupedOpenApi 划分多组或版本 API；自定义 Operation 并隐藏内部端点；以及通过 Maven/Gradle 插件在构建阶段导出 openapi.json。使用方式：先引入依赖，如 Maven 中用 org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.13，WebFlux 用 springdoc-openapi-starter-webflux-ui，或 Gradle 的 implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.13'；再在 application.properties 或 yml 中配置 springdoc.api-docs.path 与 swagger-ui.path 等项。默认访问 OpenAPI JSON 为 http://localhost:8080/v3/api-docs，YAML 为 /v3/api-docs.yaml，Swagger UI 为 /swagger-ui/index.html。适用场景为需要快速生成交互式 API 文档的 Spring 后端项目。限制方面，资料未提供收费、价格、性能或实际效果数据，版本号与配置须以项目实际为准。