Api Documentation
This is a structured workflow for building complete API documentation, from generating OpenAPI specs to deploying interactive docs. It walks you through seven phases: discovering endpoints, writing the OpenAPI schema, creating developer guides, adding code examples in multiple languages, setting up Swagger UI or Redoc, building the documentation site, and automating maintenance. The workflow references several supporting skills like api-documenter and openapi-spec-generation throughout. It's most useful if you're starting from scratch or standardizing an existing but messy API docs setup. The phased approach keeps you from forgetting the authentication guide or rate limit documentation that always gets skipped.
- skills.sh installs
- 215
- GitHub stars
- 39.4K
- last updated
- Jun 3, 2026
Install
$ npx -y skills add sickn33/antigravity-awesome-skills --skill api-documentation --agent claude-codeInstalls into .claude/skills of the current project.
Files
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
Scope and execution
Choose the phases that match the user’s task; this document is an index, not an instruction to run every listed skill. Read a selected skill before using it. Respect repository and user constraints. Cloud calls, host configuration, publishing, destructive operations and spending require the applicable authorization; a workflow checklist does not grant it.
Base the contract on the actual implementation/specification and keep secrets out of examples. “Try it” can send real requests: use explicit sandbox endpoints and test credentials. Preview documentation locally before publishing; deployment is a separate authorized action.
Workflow Phases
Phase 1: API Discovery
Skills to Invoke
api-documenter- API documentationapi-design-principles- API design
Sponsors
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/sickn33/antigravity-awesome-skills
- Categories
- Backend & APIs, Documentation
- First seen
- Jun 3, 2026
More from sickn33/antigravity-awesome-skills
All 708- Context Driven Development215
- Googlesheets Automation215
- Linear Claude Skill215
- N8n Code Python215
- Security Bluebook Builder215
- Haskell Pro213
- Threat Mitigation Mapping212
- Cc Skill Clickhouse Io211
- Embedding Strategies210
- Xlsx208
- Cqrs Implementation207
- Bats Testing Patterns206
- Antigravity Skill Orchestrator205
- Conductor Validator205
- Julia Pro205
- X Article Publisher Skill205
- Ml Pipeline Workflow204
- Distributed Tracing203
- Fix Review203
- Pci Compliance203
- Team Collaboration Issue203
- Fal Generate201
- Graphql Architect201
- Incident Response Incident Response201
Recommended
More Backend & APIs
zentao-apieasysoft/zentao-skills调用禅道（ZenTao）RESTful API v2.0 完成用户请求，覆盖项目集、产品、项目、执行、需求（Story/Epic/Requirement）、Bug、任务、测试用例、测试单、产品计划、版本、发布、反馈、工单、应用、用户、文件等 20 个模块的增删改查及状态流转操作。当用户提到禅道、zentao、查询项目进206skills.sh installs
server-actionsdavepoon/buildwithclaudeThis skill should be used when the user asks about "Server Actions", "form handling in Next.js", "mutations", "useFormState", "useFormStatus", "revalidatePath",203skills.sh installs
edge-ttsvaibhav0806/trying-somethingText-to-speech conversion using `uvx edge-tts` for generating audio from text. Use when (1) User requests audio/voice output with the "tts" trigger or keyword. 203skills.sh installs