Api Generating

huangjia2019/claude-code-engineering

This does the grunt work of turning your API code into documentation, whether you need markdown for your README or a proper OpenAPI spec. It scans route definitions across different frameworks, pulls out methods, paths, parameters, and schemas, then generates structured docs. Includes Python scripts to auto-detect routes and validate specs, plus templates for consistent formatting. Honestly most useful when you've already built the API and realize you have zero documentation, or when you're scaffolding new endpoints and want the boilerplate handled. Supports the usual suspects like REST patterns and Swagger output. Won't write your API for you, but it'll document what's there faster than doing it by hand.

GitHub stars: 826
last updated: May 30, 2026

View on GitHub

Install

$ npx -y skills add huangjia2019/claude-code-engineering --skill api-generating --agent claude-code

Installs into .claude/skills of the current project.

Files

API Documentation Generator

Generate comprehensive API documentation from source code.

Quick Reference

Task	Resource
Identify framework	See `PATTERNS.md`
Documentation standards	See `STANDARDS.md`
Example outputs	See `EXAMPLES.md`

Process

Step 1: Identify API Endpoints

Look for route definitions. For framework-specific patterns, see PATTERNS.md.

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 each endpoint.

Step 4: Create Overview

Generate an index using templates/index.md.

Output Formats

Markdown (Default)

Generate markdown suitable for README or docs site.

OpenAPI/Swagger

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

Automation

To auto-detect routes:

python scripts/detect_routes.py <source_directory>

To validate OpenAPI spec:

./scripts/validate_openapi.sh <spec_file>

SKILL.md on GitHub

Details

Repository: github.com/huangjia2019/claude-code-engineering
Categories: Backend & APIs, Documentation, Automation & Workflows
First seen: Jun 11, 2026

More from huangjia2019/claude-code-engineering

All 11