api-documentation-writer — Claude Code skill: what it does & install
Generates developer documentation, OpenAPI specs, and code samples for REST, GraphQL, and gRPC APIs. It structures endpoints, error formats, and rate limits.
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a claude-codeWhat api-documentation-writer does
This skill creates API reference guides and OpenAPI specifications directly from your project details. It covers REST, GraphQL, WebSocket, and gRPC architectures. The workflow starts by identifying authentication schemes like JWT or OAuth, base URLs, and route endpoints.
Three reference guides shape the output. The file references/documentation-structure.md organizes sections by prioritizing frequent operations. Markdown layouts follow references/output-template.md. Before output delivery, results are verified against the checklist in references/best-practices.md.
Placeholders are strictly replaced with realistic payload samples for requests and responses. The guide requires documenting standard error bodies, HTTP 429 conditions, and rate limit headers. Every documented endpoint includes code snippets in curl, JavaScript, and Python.
What it helps with
- Generate OpenAPI and Swagger specifications from endpoint data
- Draft REST documentation with request and response payloads
- Document GraphQL schemas with queries, mutations, and subscriptions
- Explain authentication methods using API keys, OAuth, or JWT
- Structure error handling guides covering rate limits and 429 status codes
Example prompts for the agent
- Write API documentation for my REST endpoints with curl and Python samples
- Create an OpenAPI spec and authentication guide for this service
- Document this GraphQL schema including mutations and error responses
How to install api-documentation-writer
1Skills CLI (Vercel)
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a claude-code2Manually: put the files in place
~/.claude/skills/api-documentation-writer/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/api-documentation-writer/
1Skills CLI (Vercel)
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a codex2Manually: put the files in place
.agents/skills/api-documentation-writer/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a cursor2Manually: put the files in place
.cursor/skills/api-documentation-writer/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install OneWave-AI/claude-skills api-documentation-writer2Manually: put the files in place
.github/skills/api-documentation-writer/SKILL.md1Skills CLI (Vercel)
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a gemini-cli2Platform CLI
gemini skills install https://github.com/OneWave-AI/claude-skills --path api-documentation-writerManually: put the files in place
.devin/skills/api-documentation-writer/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about api-documentation-writer
How do I install api-documentation-writer in Claude Code?
Run npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a claude-code. The file is stored at ~/.claude/skills/api-documentation-writer/SKILL.md.
What API architectures does this skill support?
It handles REST, GraphQL, WebSocket, and gRPC services. Output ranges from Markdown guides and OpenAPI specs to GraphQL schema references.
Which programming languages are used for code samples?
The workflow creates working examples in curl, JavaScript, and Python. It also links available SDKs, Postman collections, or OpenAPI files.
Source text
SKILL.md · MIT
--- name: api-documentation-writer description: Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation. --- # API Documentation Writer Generate comprehensive, developer-friendly API documentation. ## Contents - `references/documentation-structure.md` — every section to cover (overview, auth, endpoints, errors, rate limits, SDKs, webhooks, GraphQL) - `references/output-template.md` — canonical REST Markdown template with worked examples - `references/best-practices.md` — best practices, developer-experience tips, and the output quality checklist ## Workflow 1. Gather API information. Determine the API type (REST, GraphQL, WebSocket, gRPC), authentication method (API key, OAuth, JWT), base URL and versioning strategy, available endpoints and their purposes, request/response formats, and any rate limiting or usage restrictions. 2. Build the documentation structure. Cover every section in `references/documentation-structure.md`, ordering the most common operations first. 3. Generate the output. Follow `references/output-template.md` for REST APIs; adapt to schema, query, mutation, and subscription examples for GraphQL. Replace all placeholders with realistic example data and show both request and response. 4. Document errors and rate limits. Include the standard error response format, common error codes, troubleshooting guidance, limits, headers to check, and how to handle `429` responses. 5. Provide code samples in multiple languages (curl, JavaScript, Python) and link SDKs, Postman collections, or OpenAPI specs where available. 6. Verify quality against the checklist in `references/best-practices.md` before delivering. ## Example Triggers - "Write API documentation for my REST endpoints" - "Create OpenAPI spec for my API" - "Document this GraphQL schema" - "Generate developer docs for my webhook API" - "Write authentication guide for API"
© OneWave-AI · MIT · OneWave-AI/claude-skills
