springdoc/springdoc-openapi

这是什么？

核心功能

• 01在运行时基于 Spring Boot 代码生成 JSON 和 YAML 格式的 OpenAPI 3 描述。
• 02提供 Swagger UI 或 Scalar 页面用于浏览和调试接口。
• 03支持 Spring Web MVC、WebFlux 及函数式端点。
• 04与 Spring Security、OAuth 2、Spring Data REST、HATEOAS 集成。
• 05识别 @NotNull、@Min、@Max、@Size 等 Bean Validation 注解。
• 06提供 Maven 和 Gradle 插件，可在构建时生成接口文档。

适用场景

• 为基于 Spring Boot 的 REST API 生成文档，无需手写 OpenAPI 文件。
• 为前端或外部团队提供可交互的接口调试页面。
• 通过 MCP 将 Spring 接口暴露给 AI 智能体调用。
• 在构建阶段生成 OpenAPI 文件，用于客户端代码生成或接口契约检查。

收录于专题

标签

常见问题

springdoc-openapi 是什么？

为 Spring Boot 应用运行时自动生成 OpenAPI 3 文档，并提供 Swagger UI 或 Scalar 页面。 springdoc-openapi 是一个面向 Spring Boot 应用的 Java 库，在运行时读取控制器、配置、校验注解和 Bean Validation 约束，生成 OpenAPI 3 描述，并以 JSON 和 YAML 格式提供访问，同时附带可交互的 Swagger UI 或 Scalar 页面。只需添加一个依赖即可使用，无需额外配置。

springdoc-openapi 可以免费使用吗？用的什么许可证？

springdoc-openapi 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。

springdoc-openapi 还在维护吗？

活跃维护中。springdoc-openapi 最近一次提交是在 2026年11月6日。

springdoc-openapi 适合用来做什么？

为基于 Spring Boot 的 REST API 生成文档，无需手写 OpenAPI 文件。 为前端或外部团队提供可交互的接口调试页面。 通过 MCP 将 Spring 接口暴露给 AI 智能体调用。 在构建阶段生成 OpenAPI 文件，用于客户端代码生成或接口契约检查。

在哪里获取 springdoc-openapi？

源代码和安装说明在 GitHub 上：https://github.com/springdoc/springdoc-openapi