documenting-api-contracts
CommunityKeep API contracts and clients in sync.
Authorsomachak
Version1.0.0
Installs0
System Documentation
What problem does it solve?
OpenAPI contracts, changelogs, and client SDKs often drift from code. This skill ensures documentation stays aligned with the implementation, reducing integration friction.
Core Features & Use Cases
- Generate OpenAPI 3.0 compliant documentation that mirrors code changes.
- Create changelogs for breaking changes, deprecations, and new features alongside docs.
- Produce client SDK scaffolds (TypeScript, Python) that align with the API surface and versions.
- Use case: Ship a new endpoint and automatically refresh docs, changelog, and client stubs to keep all surfaces consistent.
Quick Start
Generate OpenAPI docs, changelog, and client SDK scaffolds that stay in sync with your codebase.
Dependency Matrix
Required Modules
None requiredComponents
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: documenting-api-contracts Download link: https://github.com/somachak/claude-code-skills-db/archive/main.zip#documenting-api-contracts 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.