springdoc/springdoc-openapi
Springdoc Openapi
springdoc-openapi is a library and toolset that analyzes Spring applications at runtime to produce machine-readable OpenAPI specifications in JSON and YAML formats. It serves as an integrator that extracts API metadata from Java source code and annotations to automate documentation for Spring-based services.
The project distinguishes itself through its ability to aggregate API specifications from multiple remote microservices into a single unified interface and provide multiple visualization options, including Swagger UI and Scalar. It also offers a dedicated plugin for exporting documentation files during the build process rather than relying solely on runtime generation.
The toolset covers a broad range of capabilities, including API security documentation, the handling of reverse proxy headers for correct URL resolution, and the exposure of documentation through Spring Actuator. It provides mechanisms for endpoint grouping, content filtering, and the programmatic customization of OpenAPI objects.
Features
- OpenAPI Specification Generators - Analyzes applications at runtime to produce machine-readable OpenAPI specifications in JSON and YAML formats.
- Automated API Documentation - Generating machine-readable OpenAPI specifications from Spring source code and annotations at runtime.
- Interactive API Reference Rendering - A web-based interface that renders OpenAPI specifications in HTML for browsing, testing, and interacting with API endpoints.
- API Specification Importers - A system for importing and displaying remote API specifications from multiple external services within a single unified interface.
- Source Code Documentation Tools - Extracts operation and schema descriptions directly from source code comments and tags to build API documentation.
- Specification Aggregators - Combining API specifications from multiple remote services into a single unified documentation interface.
- Code Annotations - Extracts API definitions and security schemes from source code markers to populate the specification model.
- Runtime Schema Derivation - Analyzes application controllers and method signatures at runtime to automatically derive API specifications.
- Classpath Service Discovery - Identifies API endpoints by scanning the application context for specific framework controllers and request mappings.
- Spring Framework Specialized Documentation - Handles specialized documentation for data REST, hypermedia, security, and system monitoring endpoints within Spring.
- API Metadata Generators - Generates structured API metadata such as titles, versions, and licenses using source code annotations.
- Interactive API Documentation UIs - The project generates an interactive HTML interface to visualize and test API resources using Swagger UI.
- Build-Time Specification Exports - The project generates JSON or YAML API definitions during the build process using dedicated plugins.
- Documentation Exporters - A utility that exports OpenAPI JSON and YAML files during the build process instead of generating them at runtime.
- Build Plugins - Extracts API definitions during the compilation phase to produce static specification files.
- Scalar API Visualization - Displays an interactive API documentation interface with a built-in client for testing requests via Scalar.
- API Authentication Schemes - The project defines authentication methods and protects specific API operations using security requirement tags and beans.
- Security Scheme Documentation - Defining authentication schemes and security requirements within OpenAPI specs to standardize protected endpoint access.
- API Aggregators - Aggregates API specifications from multiple remote microservices into a single unified documentation interface.
- Management Endpoint Exposures - The project serves the API specification and user interface through a dedicated management port via Spring Actuator.
- API Endpoint Testing - Providing a web-based user interface to visualize endpoints and test live API requests without external tools.
- API Documentation Hosting - Deploys a web-based interface that renders API documentation in HTML for browsing and testing.
- Specification Customizations - The project modifies the generated API specification programmatically through custom implementation extensions.
- REST Frameworks - Automates API documentation generation for Spring Boot projects.
