Adding SpringDoc to Your Project
Generate OpenAPI docs automatically.
Why document your API?
An API without docs is hard to consume. OpenAPI (formerly Swagger) is a standard, machine-readable description of your REST API that powers interactive docs, client generation and contract testing.
What SpringDoc does
SpringDoc OpenAPI inspects your Spring controllers at runtime and generates the OpenAPI spec automatically - no hand-written YAML needed.
- Reads your
@RestControllermappings - Serves the spec and a Swagger UI
All lessons in this course
- Adding SpringDoc to Your Project
- Documenting Endpoints and Models
- Customizing the OpenAPI Spec
- Swagger UI