[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill-4fa2e32b-761e-4c95-808e-9d7a2536259c":3,"$fDC5b0v6Qt48sLBMX4-Bwrv6nLcq8ffxQzgVmkD7nSg8":42},{"id":4,"title":5,"description":6,"categoryId":7,"moduleId":8,"tags":9,"prompt":10,"icon":11,"source":12,"sourceUrl":13,"authorId":14,"authorName":15,"isPublic":16,"stars":17,"runs":18,"createdAt":19,"updatedAt":19,"module":20,"category":27,"packages":33},"4fa2e32b-761e-4c95-808e-9d7a2536259c","api-documentation","API文档工作流程，用于生成OpenAPI规范、创建开发者指南和维护全面的API文档。","cat_coding_backend","mod_coding","sickn33,coding","---\nname: api-documentation\ndescription: \"API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.\"\ncategory: granular-workflow-bundle\nrisk: safe\nsource: personal\ndate_added: \"2026-02-27\"\n---\n\n# API Documentation Workflow\n\n## Overview\n\nSpecialized workflow for creating comprehensive API documentation including OpenAPI\u002FSwagger specs, developer guides, code examples, and interactive documentation.\n\n## When to Use This Workflow\n\nUse this workflow when:\n- Creating API documentation\n- Generating OpenAPI specs\n- Writing developer guides\n- Adding code examples\n- Setting up API portals\n\n## Workflow Phases\n\n### Phase 1: API Discovery\n\n#### Skills to Invoke\n- `api-documenter` - API documentation\n- `api-design-principles` - API design\n\n#### Actions\n1. Inventory endpoints\n2. Document request\u002Fresponse\n3. Identify authentication\n4. Map error codes\n5. Note rate limits\n\n#### Copy-Paste Prompts\n```\nUse @api-documenter to discover and document API endpoints\n```\n\n### Phase 2: OpenAPI Specification\n\n#### Skills to Invoke\n- `openapi-spec-generation` - OpenAPI\n- `api-documenter` - API specs\n\n#### Actions\n1. Create OpenAPI schema\n2. Define paths\n3. Add schemas\n4. Configure security\n5. Add examples\n\n#### Copy-Paste Prompts\n```\nUse @openapi-spec-generation to create OpenAPI specification\n```\n\n### Phase 3: Developer Guide\n\n#### Skills to Invoke\n- `api-documentation-generator` - Documentation\n- `documentation-templates` - Templates\n\n#### Actions\n1. Create getting started\n2. Write authentication guide\n3. Document common patterns\n4. Add troubleshooting\n5. Create FAQ\n\n#### Copy-Paste Prompts\n```\nUse @api-documentation-generator to create developer guide\n```\n\n### Phase 4: Code Examples\n\n#### Skills to Invoke\n- `api-documenter` - Code examples\n- `tutorial-engineer` - Tutorials\n\n#### Actions\n1. Create example requests\n2. Write SDK examples\n3. Add curl examples\n4. Create tutorials\n5. Test examples\n\n#### Copy-Paste Prompts\n```\nUse @api-documenter to generate code examples\n```\n\n### Phase 5: Interactive Docs\n\n#### Skills to Invoke\n- `api-documenter` - Interactive docs\n\n#### Actions\n1. Set up Swagger UI\n2. Configure Redoc\n3. Add try-it functionality\n4. Test interactivity\n5. Deploy docs\n\n#### Copy-Paste Prompts\n```\nUse @api-documenter to set up interactive documentation\n```\n\n### Phase 6: Documentation Site\n\n#### Skills to Invoke\n- `docs-architect` - Documentation architecture\n- `wiki-page-writer` - Documentation\n\n#### Actions\n1. Choose platform\n2. Design structure\n3. Create pages\n4. Add navigation\n5. Configure search\n\n#### Copy-Paste Prompts\n```\nUse @docs-architect to design API documentation site\n```\n\n### Phase 7: Maintenance\n\n#### Skills to Invoke\n- `api-documenter` - Doc maintenance\n\n#### Actions\n1. Set up auto-generation\n2. Configure validation\n3. Add review process\n4. Schedule updates\n5. Monitor feedback\n\n#### Copy-Paste Prompts\n```\nUse @api-documenter to set up automated doc generation\n```\n\n## Quality Gates\n\n- [ ] OpenAPI spec complete\n- [ ] Developer guide written\n- [ ] Code examples working\n- [ ] Interactive docs functional\n- [ ] Documentation deployed\n\n## Related Workflow Bundles\n\n- `documentation` - Documentation\n- `api-development` - API development\n- `development` - Development\n\n## Limitations\n- Use this skill only when the task clearly matches the scope described above.\n- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.\n- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.\n","","imported","https:\u002F\u002Fgithub.com\u002Fsickn33\u002Fantigravity-awesome-skills","user_system_seed","SkillOPIC",true,134,1840,"2026-05-16 13:03:19",{"id":8,"name":21,"slug":22,"icon":23,"description":24,"sort":25,"createdAt":26},"编程开发","coding","mdi-code-braces","代码生成、调试、审查，提升开发效率",2,"2026-05-16 12:53:40",{"id":7,"name":28,"slug":29,"icon":30,"description":31,"moduleId":8,"sort":25,"skillCount":32,"createdAt":26},"后端开发","backend","mdi-server","API、数据库、服务端架构",296,[34],{"id":35,"skillId":4,"version":36,"fileName":37,"fileSize":38,"filePath":39,"fileHash":40,"manifest":41,"createdAt":19},"68ee03a1-51ae-4a5e-9d16-0f1ee3942643","1.0.0","api-documentation.zip",1396,"uploads\u002Fskills\u002F4fa2e32b-761e-4c95-808e-9d7a2536259c\u002Fapi-documentation.zip","3f97b4daf7de8dd0d568ba86a4c6c0c3072d411ae1bf993485cc83d1e0d69a07","[{\"path\":\"SKILL.md\",\"isDirectory\":false,\"size\":3605}]",{"code":43,"message":44,"data":45},200,"success",{"items":46,"stats":47,"page":50},[],{"averageRating":48,"totalRatings":48,"ratingCounts":49},0,[48,48,48,48,48],{"limit":51,"offset":48,"hasMore":52,"nextOffset":51,"ratedOnly":16},15,false]