API Documentation
OpenAPI/Swagger, schema-driven documentation, examples, and interactive API docs.
Install
/plugin marketplace add sethdford/claude-skillsThe repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.
npx skills add sethdford/claude-skills --skill api-documentationgit clone --depth 1 https://github.com/sethdford/claude-skills.git /tmp/claude-skills
mkdir -p ~/.claude/skills
cp -r /tmp/claude-skills/engineer/api-development/skills/api-documentation ~/.claude/skills/api-documentationPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# API Documentation Creating accurate, useful API documentation from schemas. ## Context You are documenting an API. Use schema-driven docs; keep them in sync with code. ## Domain Context - **OpenAPI/Swagger**: Standard format for REST APIs - **Schema-Driven**: Docs generated from schema; always in sync - **Examples**: Include request/response examples for every endpoint - **Interactive**: Tools like Swagger UI let clients try the API - **Clarity**: Document error cases, rate limits, auth requirements ## Instructions 1. **Write OpenAPI Spec**: Define paths, parameters, responses 2. **Include Examples**: Show request/response for common cases 3. **Document Errors**: What 4xx/5xx responses are possible? 4. **Explain Auth**: How do clients authenticate? Token format? 5. **Rate Limits**: What are the limits? How to handle 429? 6. **Generate Docs**: Use tools to create HTML docs 7. **Test Docs**: Verify examples actually work ## Anti-Patterns - Handwritten docs that drift from code; automated is better - No examples; "see code" isn't helpful for API users - Incomplete error documentation; clients don't know how to handle failures - Not documenting required auth; clients struggle in production - Not versioning docs; old clients can't find docs for their version ## Further Reading - OpenAPI specification - Swagger/OpenAPI tools (SwaggerUI, Redoc) - API documentation best practices
Details
- Skill name
api-documentation- Repository
- sethdford/claude-skills
- Path
engineer/api-development/skills/api-documentation/SKILL.md- License
- MIT
- Repo updated
- 11 March 2026
FAQ
What does the API Documentation skill do?
OpenAPI/Swagger, schema-driven documentation, examples, and interactive API docs.
How do I install the API Documentation skill?
Claude Code plugin: /plugin marketplace add sethdford/claude-skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is API Documentation popular?
It lives in sethdford/claude-skills, which has 48 GitHub stars and 10 forks.
Related skills
A B Test Design
48sethdford/claude-skills
Design rigorous A/B tests with hypotheses, variants, metrics, and sample size calculations.
A B Test Design Pm
48sethdford/claude-skills
Analytics and experimentation skill for product managers.
Abuse Case Design
48sethdford/claude-skills
Design abuse cases (negative use cases) showing how attackers misuse system features. Use when identifying attacks that exploit intended functionality or business logic flaws.
Audit Preparation
48sethdford/claude-skills
Prepare for compliance audits by collecting evidence, organizing documentation, and coordinating with auditors.
YAML Config
49UCSB-NLP-Chang/Skill-Usage
Use this skill when reading or writing YAML configuration files, loading vehicle parameters, or handling config file parsing with proper error handling.
Cqrs Design
48sethdford/claude-skills
Separate command (write) and query (read) models for complex domains. Use when read/write patterns diverge significantly or when audit/consistency requirements demand immutability.
Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.