spring-boot-openapi-documentation

# Spring Boot OpenAPI Documentation with SpringDoc ## Overview SpringDoc OpenAPI automates generation of OpenAPI 3.0 documentation for Spring Boot projects with a Swagger UI web interface for exploring and testing APIs. ## When to Use - Set up SpringDoc OpenAPI in Spring Boot 3.x projects - Generate OpenAPI 3.0 specifications for REST APIs - Configure and customize Swagger UI - Add detailed API documentation with annotations - Document request/response models with validation - Implement API security documentation (JWT, OAuth2, Basic Auth) - Document pageable and sortable endpoints - Add examples and schemas to API endpoints - Customize OpenAPI definitions programmatically - Support multiple API groups and versions - Document error responses and exception handlers - Add JSR-303 Bean Validation to API documentation - Support Kotlin-based Spring Boot APIs ## Quick Reference | Concept | Description | |---------|-------------| | **Dependencies** | `springdoc-openapi-starter-webmvc-ui` for WebMvc, `springdoc-openapi-starter-webflux-ui` for WebFlux | | **Configuration** | `application.yml` with `springdoc.api-docs.*` and `springdoc.swagger-ui.*` properties | | **Access Points** | OpenAPI JSON: `/v3/api-docs`, Swagger UI: `/swagger-ui/index.html` | | **Core Annotations** | `@Tag`, `@Operation`, `@ApiResponse`, `@Parameter`, `@Schema`, `@SecurityRequirement` | | **Security** | Configure security schemes in OpenAPI bean, apply with `@SecurityRequirement` | | **Pagination** | Use ...