Api Documentation Writer
Turns your API endpoints into complete developer documentation with everything needed for integration: authentication flows, endpoint specs with request/response examples, error codes, rate limiting, and multi-language code samples. It handles REST, GraphQL, WebSocket, and gRPC APIs with the structure developers actually need (quick start, working examples, troubleshooting). The output follows documentation best practices like showing realistic data, explaining every parameter, and organizing by common use cases first. Most useful when you're launching an API or need to document existing endpoints that lack proper references. Beats writing docs from scratch and keeps the format consistent across all your endpoints.
- skills.sh installs
- 384
- GitHub stars
- 422
- last updated
- Aug 21, 2026
Install
$ npx -y skills add onewave-ai/claude-skills --skill api-documentation-writer --agent claude-codeInstalls into .claude/skills of the current project.
Files
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.
Sponsors
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/onewave-ai/claude-skills
- Categories
- Backend & APIs, Security, Documentation, Debugging
- First seen
- Jun 3, 2026
More from onewave-ai/claude-skills
All 108- Landing Page Optimizer381
- Sales Methodology Implementer377
- Objection Pattern Detector373
- Responsive Layout Builder370
- Financial Goal Planner368
- Conversation Archaeologist366
- Sales Coaching Plan Generator363
- Customer Review Aggregator361
- Brand Consistency Checker359
- Cross Conversation Project Manager356
- Injury Report Tracker356
- Sales Forecast Builder356
- Tax Strategy Optimizer356
- Highlight Reel Scripter355
- Sales Call Prep Assistant353
- Seo Keyword Cluster Builder352
- Personalization At Scale350
- Slack Message Formatter349
- Podcast Studio348
- Expert Panel347
- Training Log Analyzer347
- Competitor Content Analyzer343
- Internal Email Composer340
- Lookalike Customer Finder339
Recommended
More Backend & APIs
backend-engineersiviter-xyz/dot-agentBuild robust backend systems with modern technologies (Node.js, Python, Go, Rust), frameworks (NestJS, FastAPI, Django), databases (PostgreSQL, MongoDB, Redis),349skills.sh installs
flutter-firebasedhruvanbhalara/skillsIntegrate Firebase services including Authentication, Firestore, Cloud Messaging, Crashlytics, and Analytics. Use when adding backend capabilities, push notific341skills.sh installs
supabase-realtimenice-wolf-studio/claude-code-supabase-skillsSubscribe to realtime changes in Supabase using WebSocket connections. Use for listening to database changes, presence tracking, and broadcast messaging.323skills.sh installs
api-test-suite-generatorpatricio0312rev/skillsGenerates comprehensive API test suites using Jest, Vitest, or Supertest from Express, Next.js, Fastify, or other API routes. Creates integration tests, contrac314skills.sh installs
dokploy-api-mcpsattva2020/skillsDeploy and manage applications on Dokploy (self-hosted PaaS). Use when deploying apps, managing Docker Compose services, databases (PostgreSQL, MySQL, MariaDB, 312skills.sh installs
railway-databasedavila7/claude-code-templatesAdd official Railway database services (Postgres, Redis, MySQL, MongoDB). Use when user wants to add a database, says "add postgres", "add redis", "add database310skills.sh installs