api-contract-doc-sync
CommunityKeep API contracts and docs perfectly in sync.
AuthorYuriGarciaRibeiro
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Maintains alignment between API contracts (payloads, responses, HTTP statuses), the implemented endpoints, and the textual documentation used in Swagger/OpenAPI. It is used whenever DTOs, commands/queries, validations, examples, or endpoint descriptions change to prevent drift between code and client-facing documentation.
Core Features & Use Cases
- End-to-end synchronization: Detect impacted endpoints and ensure code, tests, and docs reflect the same contract.
- Consistent documentation: Update payloads, responses, and status codes across endpoints and their OpenAPI descriptions and examples.
- Guided workflow: Enforces a standard flow from code changes to documentation validation, with automated checks.
Quick Start
Run the contract-doc-sync workflow to verify and align API contracts with documentation.
Dependency Matrix
Required Modules
rgfind
Components
scriptsreferences
💻 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: api-contract-doc-sync Download link: https://github.com/YuriGarciaRibeiro/API-notifications/archive/main.zip#api-contract-doc-sync Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.