springfox/springfox
Springfox
Springfox is a Java library that automatically generates OpenAPI-compliant documentation for Spring-based REST services. It scans Spring controller annotations and model classes at runtime to produce machine-readable API specifications, and bootstraps an interactive Swagger UI interface on application startup for browsing and testing documented endpoints.
The project provides a migration path from Swagger 2 to OpenAPI 3, replacing legacy annotations and dependencies with OpenAPI 3 equivalents through a starter dependency and configuration change. It integrates with Spring's application context and request mapping infrastructure to discover endpoints without manual configuration, and leverages Spring Boot's auto-configuration mechanism for minimal setup.
Springfox uses Java reflection to inspect model fields, types, and annotations for generating accurate API schemas, and converts the internal documentation model into standard OpenAPI JSON structures using Jackson or similar serialization libraries. The library supports both Spring MVC and WebFlux endpoints, producing documentation automatically from annotated controllers without requiring manual specification writing.
Features
- OpenAPI Specification Generators - Produces OpenAPI-compliant JSON documentation by inspecting Spring MVC and WebFlux endpoints at runtime.
- Runtime Endpoint Inspectors - Inspects Spring MVC and WebFlux endpoints at runtime to produce OpenAPI JSON documentation.
- Automated API Documentation - Generates interactive API documentation automatically from Spring controller annotations without manual specification writing.
- Spec-from-Annotation Generators - Scans Spring controller annotations to automatically produce an OpenAPI-compliant specification.
- Interactive Documentation Bootstrappers - Bootstraps an interactive Swagger UI interface on application startup for browsing and testing REST endpoints.
- API Documentation Tools - Generates machine-readable API specifications from Spring annotations without requiring manual documentation effort.
- Interactive API Documentation UIs - Bootstraps an interactive Swagger UI interface for browsing and testing REST endpoints.
- API Schema Introspection - Uses Java reflection to inspect model fields and annotations for generating accurate API schemas.
- Annotation Migration Bridges - Replaces legacy Swagger 2 annotations and dependencies with OpenAPI 3 equivalents through a starter dependency.
- Annotation Migration Bridges - Provides a migration path from Swagger 2 annotations to OpenAPI 3 equivalents via starter dependency.
- Documentation Bootstrappers - Leverages Spring Boot auto-configuration to bootstrap Swagger UI and documentation endpoints with minimal setup.
- Endpoint Discovery Hooks - Hooks into Spring's application context and request mapping to discover endpoints without manual configuration.
