Api Documentation
Api Documentation is an code AI skill with a core value of API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation. It
helps developers solve real-world problems in the code domain, boosting
efficiency, automating repetitive tasks, and optimizing workflows.
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
Quick Facts
mkdir -p ./skills/api-documentation && curl -sfL https://raw.githubusercontent.com/sickn33/antigravity-awesome-skills/main/skills/api-documentation/SKILL.md -o ./skills/api-documentation/SKILL.mdRun in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).
Skill Content
# 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
Use @api-documenter to discover and document API endpointsPhase 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
Use @openapi-spec-generation to create OpenAPI specificationPhase 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
Use @api-documentation-generator to create developer guidePhase 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
Use @api-documenter to generate code examplesPhase 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
Use @api-documenter to set up interactive documentationPhase 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
Use @docs-architect to design API documentation sitePhase 7: Maintenance
#### Skills to Invoke
- `api-documenter` - Doc maintenance
#### Actions
1. Set up auto-generation
2. Configure validation
3. Add review process
4. Schedule updates
5. Monitor feedback
#### Copy-Paste Prompts
Use @api-documenter to set up automated doc generationQuality Gates
- [ ] OpenAPI spec complete
- [ ] Developer guide written
- [ ] Code examples working
- [ ] Interactive docs functional
- [ ] Documentation deployed
Related Workflow Bundles
- `documentation` - Documentation
- `api-development` - API development
- `development` - Development
🎯 Best For
- Technical writers
- API documentation teams
- UI designers
- Product designers
- Claude users
💡 Use Cases
- Generating JSDoc/TSDoc comments
- Writing README files for new projects
- Generating component mockups
- Creating design system tokens
📖 How to Use This Skill
- 1
Install the Skill
Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.
- 2
Load into Your AI Assistant
Open Claude and reference the skill. Paste the SKILL.md content or use the system prompt tab.
- 3
Apply Api Documentation to Your Work
Open your project in the AI assistant and ask it to apply the skill. Start with a small module to verify the output quality.
- 4
Review and Refine
Review AI suggestions before committing. Run tests, check for regressions, and iterate on the skill output.
❓ Frequently Asked Questions
Does it follow my documentation style?
Most documentation skills respect existing style. Provide a style guide or example in your prompt.
Does this work with Figma?
Some design skills integrate with Figma plugins. Check the Works With section for supported tools.
Is Api Documentation compatible with Cursor and VS Code?
Yes — this skill works with any AI coding assistant including Cursor, VS Code with Copilot, and JetBrains IDEs.
Do I need specific dependencies for Api Documentation?
Check the install command and Works With section. Most code skills only require the AI assistant and your codebase.
How do I install Api Documentation?
Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/api-documentation/SKILL.md, ready to use.
⚠️ Common Mistakes to Avoid
Auto-generating without reviewing
AI documentation can contain inaccuracies. Always verify technical accuracy.
Skipping usability testing
AI-generated designs should be validated with real users before development.
Skipping validation
Always test AI-generated code changes, even for simple refactors.
Missing dependency updates
Check if the skill requires updated dependencies or new packages.