giuseppe-trisciuoglio avatar

Spring Boot Openapi Documentation

If you're building REST APIs with Spring Boot 3.x and need proper OpenAPI 3.0 documentation, this handles the SpringDoc setup and annotation patterns. It covers the dependency configuration, Swagger UI customization, documenting controllers and models with the right annotations, and setting up security schemes for JWT or OAuth2. The skill includes patterns for pagination with Spring Data's Pageable, validation integration with JSR-303, and organizing endpoints with tags and groups. Worth noting it emphasizes keeping annotations minimal to avoid cluttering your controllers and warns about circular references in DTOs causing schema generation issues. Solid reference if you want comprehensive API docs without manually writing OpenAPI specs.

skills.sh installs
4.2K
GitHub stars
369
last updated
Aug 21, 2026

Install

$ npx -y skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

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

Sponsors

Details

Repository
github.com/giuseppe-trisciuoglio/developer-kit
Categories
Backend & APIs, Security, Documentation, Java & JVM
First seen
Apr 16, 2026

More from giuseppe-trisciuoglio/developer-kit

All 102
1assistant-ui avatarreact-mcpassistant-ui/skillsLets end users add, authenticate, and manage MCP servers from the browser in assistant-ui apps with @assistant-ui/react-mcp. Use when building user-managed MCP 4.2Kskills.sh installs
2assistant-ui avatarobservabilityassistant-ui/skillsAdds tracing, telemetry, and observability to an assistant-ui backend. Use when wiring an AI SDK route handler (streamText/generateText, toUIMessageStream, crea4.2Kskills.sh installs
3agents365-ai avatarcreating-mermaid-diagramsagents365-ai/365-skillsGenerate Mermaid diagrams (.mmd) and export to PNG/SVG/PDF using mmdc CLI or Kroki API. USE THIS SKILL when user mentions diagram, flowchart, sequence diagram, 4.2Kskills.sh installs
4elastic avatarsecurity-detection-rule-managementelastic/agent-skillsCreate, tune, and manage Elastic Security detection rules (SIEM and Endpoint). Use for false positives, exceptions, new coverage, noisy rules, or rule managemen4.1Kskills.sh installs
5openai avataraspnet-coreopenai/skillsBuild, review, refactor, or architect ASP.NET Core web applications using current official guidance for .NET web development. Use when working on Blazor Web App4.1Kskills.sh installs
6amelnagdy avatardocs-guardamelnagdy/guard-skillsReview generated or changed documentation before it ships — READMEs, API references, docstrings, PHPDoc/JSDoc, changelogs, tutorials, and doc sites. Best used r4.1Kskills.sh installs