spring-boot-openapi-documentation

SKILL.md

Automated OpenAPI 3.0 documentation generation for Spring Boot 3.x REST APIs with Swagger UI.

Integrates SpringDoc to auto-generate OpenAPI specs from annotated controllers, models, and validation rules without manual configuration

Supports JWT Bearer, OAuth2, and Basic Auth security documentation with global scheme configuration and per-endpoint security requirements

Includes comprehensive annotation patterns for documenting endpoints, request/response bodies, parameters, error responses, and pageable queries

Provides Swagger UI customization, multi-API grouping, build-time spec generation via Maven/Gradle plugins, and best practices for schema design and constraint 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