Agent skill · Backend & API

api-documentation

API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.

majiayu000github.com/majiayu000GitHub ↗
claude-codeMIT
Install
npx skills add majiayu000/claude-skill-registry --skill api-documentation --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

Facts
Files in the skill folder: 2
SKILL.md size: 4 KB
Bundled scripts: none
Path: skills/api/api-documentation/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 534
Language: HTML

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.md

# 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-te

What's inside
Steps it walks through
  1. Overview
  2. When to Use This Workflow
  3. Workflow Phases
  4. Phase 1: API Discovery
  5. Phase 2: OpenAPI Specification
  6. Phase 3: Developer Guide
  7. Phase 4: Code Examples
  8. Phase 5: Interactive Docs
  9. Phase 6: Documentation Site
  10. Phase 7: Maintenance
  11. Quality Gates
  12. Related Workflow Bundles
  13. Limitations
Ships with 1 file
  • metadata.json
More from claude-skill-registry
All skills →
About this skill
What does the api-documentation skill do?

API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.

How do I install it?

Run `npx skills add majiayu000/claude-skill-registry --skill api-documentation --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going