api-documentation-writer
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.
How do I install this agent skill?
npx skills add https://github.com/onewave-ai/claude-skills --skill api-documentation-writerIs this agent skill safe to install?
- Gen Agent Trust Hubpass
No security risks identified. The skill is designed purely for generating technical API documentation based on provided guidelines and templates.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
1/1 file flagged
What does this agent skill do?
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 examplesreferences/best-practices.md— best practices, developer-experience tips, and the output quality checklist
Workflow
-
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.
-
Build the documentation structure. Cover every section in
references/documentation-structure.md, ordering the most common operations first. -
Generate the output. Follow
references/output-template.mdfor 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. -
Document errors and rate limits. Include the standard error response format, common error codes, troubleshooting guidance, limits, headers to check, and how to handle
429responses. -
Provide code samples in multiple languages (curl, JavaScript, Python) and link SDKs, Postman collections, or OpenAPI specs where available.
-
Verify quality against the checklist in
references/best-practices.mdbefore 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"
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/onewave-ai/claude-skills/api-documentation-writer">View api-documentation-writer on skillZs</a>