soojung-kang/api-documentation
skills/api-documentation/SKILL.md
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
development
Updated Apr 15, 2026
$ install --global
skillsauthnpx skillsauth add soojung-kang/antigravity-awesome-skills api-documentationInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 3, 2026, 9:06 AM16.4s1 file scanned
SKILL.md
- name:
- api-documentation
- description:
- API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
- category:
- granular-workflow-bundle
- risk:
- safe
- source:
- personal
- date_added:
- 2026-02-27
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 documentationapi-design-principles- API design
Actions
- Inventory endpoints
- Document request/response
- Identify authentication
- Map error codes
- Note rate limits
Copy-Paste Prompts
Use @api-documenter to discover and document API endpoints
Phase 2: OpenAPI Specification
Skills to Invoke
openapi-spec-generation- OpenAPIapi-documenter- API specs
Actions
- Create OpenAPI schema
- Define paths
- Add schemas
- Configure security
- Add examples
Copy-Paste Prompts
Use @openapi-spec-generation to create OpenAPI specification
Phase 3: Developer Guide
Skills to Invoke
api-documentation-generator- Documentationdocumentation-templates- Templates
Actions
- Create getting started
- Write authentication guide
- Document common patterns
- Add troubleshooting
- Create FAQ
Copy-Paste Prompts
Use @api-documentation-generator to create developer guide
Phase 4: Code Examples
Skills to Invoke
api-documenter- Code examplestutorial-engineer- Tutorials
Actions
- Create example requests
- Write SDK examples
- Add curl examples
- Create tutorials
- Test examples
Copy-Paste Prompts
Use @api-documenter to generate code examples
Phase 5: Interactive Docs
Skills to Invoke
api-documenter- Interactive docs
Actions
- Set up Swagger UI
- Configure Redoc
- Add try-it functionality
- Test interactivity
- Deploy docs
Copy-Paste Prompts
Use @api-documenter to set up interactive documentation
Phase 6: Documentation Site
Skills to Invoke
docs-architect- Documentation architecturewiki-page-writer- Documentation
Actions
- Choose platform
- Design structure
- Create pages
- Add navigation
- Configure search
Copy-Paste Prompts
Use @docs-architect to design API documentation site
Phase 7: Maintenance
Skills to Invoke
api-documenter- Doc maintenance
Actions
- Set up auto-generation
- Configure validation
- Add review process
- Schedule updates
- Monitor feedback
Copy-Paste Prompts
Use @api-documenter to set up automated doc generation
Quality Gates
- [ ] OpenAPI spec complete
- [ ] Developer guide written
- [ ] Code examples working
- [ ] Interactive docs functional
- [ ] Documentation deployed
Related Workflow Bundles
documentation- Documentationapi-development- API developmentdevelopment- Development
Related Skills
soojung-kang/loki-mode
development
VerifiedTrustedCommunity
Multi-agent autonomous startup system for Claude Code. Triggers on "Loki Mode". Orchestrates 100+ specialized agents across engineering, QA, DevOps, security, data/ML, business operations,...
SKILL.mdUpdated Apr 26, 2026
soojung-kang/logistics-exception-management
tools
VerifiedTrustedCommunity
Codified expertise for handling freight exceptions, shipment delays, damages, losses, and carrier disputes. Informed by logistics professionals with 15+ years operational experience.
SKILL.mdUpdated Apr 25, 2026
soojung-kang/local-legal-seo-audit
testing
VerifiedTrustedCommunity
Audit and improve local SEO for law firms, attorneys, forensic experts and legal/professional services sites with local presence, focusing on GBP, directories, E-E-A-T and practice/location pages.
SKILL.mdUpdated Apr 25, 2026
soojung-kang/llm-prompt-optimizer
testing
VerifiedTrustedCommunity
Use when improving prompts for any LLM. Applies proven prompt engineering techniques to boost output quality, reduce hallucinations, and cut token usage.
SKILL.mdUpdated Apr 25, 2026