02 progressive skill

Skill huangjia2019/claude-code-engineering/04-Skills/projects/02-progressive-skill

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.From its SKILL.md

Install

npx -y skills add huangjia2019/claude-code-engineering --skill 02-progressive-skill

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.

SKILL.md

1.5 KB, 290 tokens by cl100k_base, as published. Nobody here has run it

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>