mcpbeat

API Documenting

huangjia2019/api-documenting

Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.

4k tokens
context cost
the whole folder, loaded on every use
9
files
ships runnable scripts
0
copies elsewhere
how many repositories repackaged it
1038
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/huangjia2019/claude-code-engineering --skill api-documenting

The instruction itself

13 sections, as written by the author

API Documentation Generator

Generate comprehensive API documentation from source code.

Quick Reference

For common documentation patterns, see PATTERNS.md.

Documentation Standards

See STANDARDS.md for our documentation conventions.

Process

Step 1: Identify API Endpoints

Look for:

  • Route definitions (Express, FastAPI, etc.)
  • Controller methods
  • Handler functions

Step 2: Extract Information

For each endpoint, extract:

  • HTTP method (GET, POST, PUT, DELETE, etc.)
  • Path/route
  • Parameters (path, query, body)
  • Request/response schemas
  • Authentication requirements

Step 3: Generate Documentation

Use the template in templates/endpoint.md for consistent formatting.

Step 4: Create Overview

Generate an index of all endpoints with the template in templates/index.md.

Output Formats

Markdown (Default)

Generate markdown documentation suitable for README or docs site.

OpenAPI/Swagger

If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml for structure.

Examples

See EXAMPLES.md for sample inputs and outputs.

Scripts

To auto-detect routes in common frameworks:

python scripts/detect_routes.py <source_directory>

To validate generated OpenAPI spec:

./scripts/validate_openapi.sh <spec_file>

How to use it

Copy the folder

Take huangjia2019/api-documenting 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.