Skills
.Work. You
Rest

springdoc-api-sync

Community

Keep Spring Boot APIs in sync with OpenAPI docs.

Software Engineering#documentation#openapi#swagger#spring-boot#api-docs#springdoc#api-drift
Authormu-zhi
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Automatically align Spring Boot REST controllers with OpenAPI specifications, reducing drift between implementation and documentation and ensuring API contracts stay accurate as code evolves.

Core Features & Use Cases

  • Generate and expose OpenAPI docs from code via SpringDoc and Swagger UI
  • Annotate controllers and DTOs to improve API discoverability and validation
  • Synchronize human-readable docs with generated OpenAPI output for consistent contracts
  • Use cases include onboarding new services, auditing API drift, and maintaining compatibility during refactors

Quick Start

Configure a Spring Boot project to generate OpenAPI docs using SpringDoc and access the docs at /v3/api-docs and the UI at /swagger-ui/index.html.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: springdoc-api-sync
Download link: https://github.com/mu-zhi/CaliberHub/archive/main.zip#springdoc-api-sync

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.