-
Notifications
You must be signed in to change notification settings - Fork 978
Add entry for SpringDoc OpenAPI #2088
Description
New Entry Proposal: SpringDoc OpenAPI
Code of Conduct
[x] I have read the Contributor Covenant code of conduct and agree to adhere to it.
Well-established project with a vibrant community
SpringDoc OpenAPI is the de facto library for automating the generation of OpenAPI 3.x documentation for Spring Boot applications. It is adopted by the Spring Open Source community as standard for OpenAPI 3.x and Swagger UI integration.
- Usage Statistics: According to Sonatype statistics, the project sees more than 30 million downloads per month, demonstrating its critical role in the global Java/Spring ecosystem.
- GitHub Stars: ~3.7k stars on springdoc/springdoc-openapi.
- Massive Adoption: According to GitHub's dependency graph, there are currently more than 185,000 dependent repositories using springdoc-openapi.
- Community Interest: Significant presence on Stack Overflow with over 500 tagged questions (
springdoc-openapi). - Maintenance: Highly active project with frequent updates (last updated within the week) ensuring Day 0 support for new Spring Boot milestones.
Ongoing maintenance
The project has a proven track record of maintaining parity with the Spring ecosystem. It currently provides separate release trains for:
- v2.8.x: Current stable support for Spring Boot 3.x
- v3.0.x: Modern support for Spring Boot 4.x
Licence
- Project License: Apache License 2.0
- Dependencies: All transitives (Swagger-core, WebJars, etc.) are Apache 2.0 or compatible.
Issue Tracker URL
https://github.com/springdoc/springdoc-openapi/issues
Continuous integration
CI is performed via GitHub Actions, validating compatibility across JDK 17, 21, and 25.
- CI Link: https://ci-cd.springdoc.org:8443/
Maven Central
[x] Starter and all of its dependencies are available on Maven Central.
- Group ID:
org.springdoc - Artifacts:
springdoc-openapi-starter-webmvc-ui,springdoc-openapi-starter-webflux-ui
Configuration metadata
[x] Starter provides metadata, including documentation, for all its configuration properties.
Configuration properties use the springdoc. prefix and include full description metadata for IDE autocomplete.
Build system integration
The library utilizes standard Spring Boot auto-configuration. No custom build plugins are required for dependency resolution, though a dedicated Maven/Gradle plugin is available for build-time JSON generation.
Version mappings
| Spring Boot Version | Springdoc Version | Compatibility |
|---|---|---|
[3.5.0, 4.0.0) |
2.8.15 |
Spring Boot 3.5.x Baseline |
[4.0.0, 4.1.0-M1) |
3.0.1 |
Spring Boot 4.0 |
Links to additional resources
- Reference documentation: https://springdoc.org/
- Sample / Demos: https://github.com/springdoc/springdoc-openapi-demos/