Agent skill · writing content · aiskillstore
api-documentation
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
Why this skill is useful
Provides a structured workflow for generating OpenAPI specs and comprehensive API documentation that the AI wouldn't reliably generate on its own.
What it needs
About 2k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
API Documentation Workflow Overview Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation. When to Use This Workflow Use this workflow when: Creating API documentation Generating OpenAPI specs Writing developer guides Adding code examples Setting up API portals Workflow Phases Phase 1: API Discovery Skills to Invoke api-documenter - API documentation api-design-principles - API design Actions 1. Inventory endpoints 2. Document request/response 3. Identify authentication 4. Map error codes 5. Note rate limits Copy-Paste Prompts Phase 2: OpenAPI Specification Skills to Invoke openapi-spec-generation - OpenAPI api-documenter - API specs Actions 1. Create OpenAPI schema 2. Define paths 3. Add schemas 4. Configure security 5. Add examples Copy-Paste Prompts Phase 3: Developer Guide Skills to Invoke api-documentation-generator - Documentation documentation-templates - Templates Actions 1. Create getting started 2. Write authentication guide 3. Document common patterns 4. Add troubleshooting 5. Create FAQ Copy-Paste Prompts Phase 4: Code Examples Skills to Invoke api-documenter - Code examples tutorial-engineer - Tutorials Actions 1. Create example requests 2. Write SDK examples 3. Add curl examples 4. Create tutorials 5. Test examples Copy-Paste Prompts Phase 5: Interactive Docs Skills to Invoke api-documenter - Interactive docs Actions 1. Set up Swagger UI 2. Configure Redoc 3. Add try-it functionality 4. Test interactivity 5. Deploy docs Copy-Paste Prompts Phase 6: Documentation Site Skills to Invoke docs-architect - Documentation architecture wiki-page-writer - Documentation Actions 1. Choose platform 2. Design structure 3. Create pages 4. Add navigation 5. Configure search Copy-Paste Prompts Phase 7: Maintenance Skills to Invoke api-documenter - Doc maintenance Actions 1. Set up auto-generation 2. Configure validation 3. Add review process 4. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/api-documentation--46a7af