{"id":"3f575f08-2d88-4341-b690-ec6618c8cf13","shortId":"dqCz4C","kind":"skill","title":"api-documentation","tagline":"API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.","description":"# API Documentation Workflow\n\n## Overview\n\nSpecialized workflow for creating comprehensive API documentation including OpenAPI/Swagger 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/response\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.","tags":["api","documentation","antigravity","awesome","skills","sickn33","agent-skills","agentic-skills","ai-agent-skills","ai-agents","ai-coding","ai-workflows"],"capabilities":["skill","source-sickn33","skill-api-documentation","topic-agent-skills","topic-agentic-skills","topic-ai-agent-skills","topic-ai-agents","topic-ai-coding","topic-ai-workflows","topic-antigravity","topic-antigravity-skills","topic-claude-code","topic-claude-code-skills","topic-codex-cli","topic-codex-skills"],"categories":["antigravity-awesome-skills"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/sickn33/antigravity-awesome-skills/api-documentation","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add sickn33/antigravity-awesome-skills","source_repo":"https://github.com/sickn33/antigravity-awesome-skills","install_from":"skills.sh"}},"qualityScore":"0.700","qualityRationale":"deterministic score 0.70 from registry signals: · indexed on github topic:agent-skills · 34964 github stars · SKILL.md body (3,335 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-04-25T00:50:26.686Z","embedding":null,"createdAt":"2026-04-18T21:31:06.407Z","updatedAt":"2026-04-25T00:50:26.686Z","lastSeenAt":"2026-04-25T00:50:26.686Z","tsv":"'1':68,86,135,181,229,272,323,363 '2':89,118,139,185,233,277,326,369 '3':92,142,165,189,237,280,329,372 '4':95,145,193,213,241,286,332,376 '5':99,148,196,244,260,289,335,379 '6':306 '7':352 'action':85,134,180,228,271,322,362 'ad':58 'add':143,149,194,238,281,333,373 'api':2,4,17,19,28,50,63,69,75,77,80,83,109,115,130,132,172,205,220,253,267,298,348,358,388,418,420 'api-design-principl':79 'api-develop':417 'api-document':1,74,108,129,219,252,266,297,357,387 'api-documentation-gener':171,204 'architect':314,345 'architectur':316 'ask':457 'authent':94,187 'auto':367 'auto-gener':366 'autom':393 'boundari':465 'bundl':414 'choos':324 'clarif':459 'clear':432 'code':35,59,98,214,222,257,404 'common':191 'complet':400 'comprehens':16,27 'configur':146,278,336,370 'copi':104,152,200,248,293,339,383 'copy-past':103,151,199,247,292,338,382 'creat':11,26,49,136,161,182,197,209,230,242,330 'criteria':468 'curl':239 'defin':140 'deploy':290,411 'describ':436 'design':81,84,327,347 'develop':12,33,56,166,210,401,419,421,422,423 'discov':112 'discoveri':70 'doc':262,270,291,313,344,360,394,408 'docs-architect':312,343 'document':3,5,18,20,29,39,51,76,78,90,110,114,131,173,175,177,190,206,221,254,268,299,304,307,315,321,349,359,389,410,415,416 'documentation-templ':176 'endpoint':88,116 'engin':226 'environ':448 'environment-specif':447 'error':97 'exampl':36,60,150,215,223,231,236,240,246,258,405 'expert':453 'faq':198 'feedback':381 'function':285,409 'gate':397 'generat':8,52,127,159,174,207,256,368,395 'get':183 'guid':13,34,57,167,188,211,402 'identifi':93 'includ':30 'input':462 'interact':38,261,269,288,303,407 'inventori':87 'invok':73,123,170,218,265,311,356 'limit':102,424 'maintain':15 'mainten':353,361 'map':96 'match':433 'miss':470 'monitor':380 'navig':334 'note':100 'openapi':9,53,119,125,128,137,157,162,398 'openapi-spec-gener':124,156 'openapi/swagger':31 'output':442 'overview':22 'page':319,331 'past':105,153,201,249,294,340,384 'path':141 'pattern':192 'permiss':463 'phase':66,67,117,164,212,259,305,351 'platform':325 'portal':64 'principl':82 'process':375 'prompt':106,154,202,250,295,341,385 'qualiti':396 'rate':101 'redoc':279 'relat':412 'request':232 'request/response':91 'requir':461 'review':374,454 'safeti':464 'schedul':377 'schema':138,144 'scope':435 'sdk':235 'search':337 'secur':147 'set':61,273,301,364,391 'site':308,350 'skill':71,121,168,216,263,309,354,427 'skill-api-documentation' 'source-sickn33' 'spec':10,32,54,126,133,158,399 'special':23 'specif':120,163,449 'start':184 'stop':455 'structur':328 'substitut':445 'success':467 'swagger':275 'task':431 'templat':178,179 'test':245,287,451 'topic-agent-skills' 'topic-agentic-skills' 'topic-ai-agent-skills' 'topic-ai-agents' 'topic-ai-coding' 'topic-ai-workflows' 'topic-antigravity' 'topic-antigravity-skills' 'topic-claude-code' 'topic-claude-code-skills' 'topic-codex-cli' 'topic-codex-skills' 'treat':440 'tri':283 'troubleshoot':195 'try-it':282 'tutori':225,227,243 'tutorial-engin':224 'ui':276 'updat':378 'use':42,45,107,155,203,251,296,342,386,425 'valid':371,450 'wiki':318 'wiki-page-writ':317 'work':406 'workflow':6,21,24,44,47,65,413 'write':55,186,234 'writer':320 'written':403","prices":[{"id":"28132cdd-2555-46d1-90cd-90a87bbc3bde","listingId":"3f575f08-2d88-4341-b690-ec6618c8cf13","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"sickn33","category":"antigravity-awesome-skills","install_from":"skills.sh"},"createdAt":"2026-04-18T21:31:06.407Z"}],"sources":[{"listingId":"3f575f08-2d88-4341-b690-ec6618c8cf13","source":"github","sourceId":"sickn33/antigravity-awesome-skills/api-documentation","sourceUrl":"https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation","isPrimary":false,"firstSeenAt":"2026-04-18T21:31:06.407Z","lastSeenAt":"2026-04-25T00:50:26.686Z"}],"details":{"listingId":"3f575f08-2d88-4341-b690-ec6618c8cf13","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"sickn33","slug":"api-documentation","github":{"repo":"sickn33/antigravity-awesome-skills","stars":34964,"topics":["agent-skills","agentic-skills","ai-agent-skills","ai-agents","ai-coding","ai-workflows","antigravity","antigravity-skills","claude-code","claude-code-skills","codex-cli","codex-skills","cursor","cursor-skills","developer-tools","gemini-cli","gemini-skills","kiro","mcp","skill-library"],"license":"mit","html_url":"https://github.com/sickn33/antigravity-awesome-skills","pushed_at":"2026-04-24T06:41:17Z","description":"Installable GitHub library of 1,400+ agentic skills for Claude Code, Cursor, Codex CLI, Gemini CLI, Antigravity, and more. Includes installer CLI, bundles, workflows, and official/community skill collections.","skill_md_sha":"e404eb88d0210ca232882c8d18c818791074078d","skill_md_path":"skills/api-documentation/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation"},"layout":"multi","source":"github","category":"antigravity-awesome-skills","frontmatter":{"name":"api-documentation","description":"API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation."},"skills_sh_url":"https://skills.sh/sickn33/antigravity-awesome-skills/api-documentation"},"updatedAt":"2026-04-25T00:50:26.686Z"}}