spring-boot-openapi-documentation - 使用 SpringDoc 生成 Spring Boot OpenAPI 文档
使用 SpringDoc 为 Spring Boot 3.x REST API 生成 OpenAPI 3.0 文档和 Swagger UI。
标签
更新于: 2026-06-30能力
典型输入
典型输出
该技能可以做什么
- 生成 OpenAPI 3.0 规范
- 配置 Swagger UI 设置
- 为控制器添加 OpenAPI 注解
- 文档化请求与响应模型
- 配置 API 安全方案
- 文档化分页端点
- 编程式自定义 OpenAPI 定义
- 按领域或版本分组 API
- 文档化错误响应
输入
- Spring Boot 3.x 项目
- Maven 或 Gradle 构建文件
- REST API 控制器类
- DTO 或实体类
- application.yml 配置文件
输出
- OpenAPI 3.0 JSON 规范
- Swagger UI 网页界面
- 带注解的控制器与模型源文件
- OpenAPI 配置 Bean 源代码
要求
- Spring Boot 3.x 应用
- Java 或 Kotlin 运行时
- Maven 或 Gradle 构建系统
- SpringDoc OpenAPI starter 依赖