mcpbeat

API Documentation

lingxling/api-documentation

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

901 tokens
context cost
the whole folder, loaded on every use
1
files
instructions only
1
copies elsewhere
how many repositories repackaged it
223
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository 
npx skills add https://github.com/lingxling/awesome-skills-cn --skill api-documentation

The instruction itself

35 sections, as written by the author

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
  • Inventory endpoints
  • Document request/response
  • Identify authentication
  • Map error codes
  • 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
  • Create OpenAPI schema
  • Define paths
  • Add schemas
  • Configure security
  • 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
  • Create getting started
  • Write authentication guide
  • Document common patterns
  • Add troubleshooting
  • Create FAQ
Copy-Paste Prompts
Use @api-documentation-generator to create developer guide

Phase 4: Code Examples

Skills to Invoke
  • api-documenter - Code examples
  • tutorial-engineer - Tutorials
Actions
  • Create example requests
  • Write SDK examples
  • Add curl examples
  • Create tutorials
  • Test examples
Copy-Paste Prompts
Use @api-documenter to generate code examples

Phase 5: Interactive Docs

Skills to Invoke
  • api-documenter - Interactive docs
Actions
  • Set up Swagger UI
  • Configure Redoc
  • Add try-it functionality
  • Test interactivity
  • Deploy docs
Copy-Paste Prompts
Use @api-documenter to set up interactive documentation

Phase 6: Documentation Site

Skills to Invoke
  • docs-architect - Documentation architecture
  • wiki-page-writer - Documentation
Actions
  • Choose platform
  • Design structure
  • Create pages
  • Add navigation
  • Configure search
Copy-Paste Prompts
Use @docs-architect to design API documentation site

Phase 7: Maintenance

Skills to Invoke
  • api-documenter - Doc maintenance
Actions
  • Set up auto-generation
  • Configure validation
  • Add review process
  • Schedule updates
  • Monitor feedback
Copy-Paste Prompts
Use @api-documenter to set up automated doc generation

Quality Gates

  • [ ] OpenAPI spec complete
  • [ ] Developer guide written
  • [ ] Code examples working
  • [ ] Interactive docs functional
  • [ ] Documentation deployed

Related Workflow Bundles

  • documentation - Documentation
  • api-development - API development
  • development - Development

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

Repackaged in 1 other repositories

same content, different owner
aiskillstore/marketplace open on GitHub →
lingxling/awesome-skills-cn open on GitHub →

How to use it

Copy the folder

Take lingxling/api-documentation from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.