← ClaudeAtlas

api-documentationlisted

API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
LiHongwei-cn/lihongwei-cn · ★ 3 · AI & Automation · score 75
Install: claude install-skill LiHongwei-cn/lihongwei-cn
# 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 endpoints ``` ### 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 ``` Use @openapi-spec-generation to create OpenAPI specification ``` ### 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 ``` Use @api-documentation-generator to create developer guide ``` ### Phase 4: Code Examples #### Ski