Claude-code-engineering api-generating

Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.

install
source · Clone the upstream repo
git clone https://github.com/huangjia2019/claude-code-engineering
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/huangjia2019/claude-code-engineering "$T" && mkdir -p ~/.claude/skills && cp -r "$T/04-Skills/projects/05-api-generator/.claude/skills/api-generating" ~/.claude/skills/huangjia2019-claude-code-engineering-api-generating && rm -rf "$T"
manifest: 04-Skills/projects/05-api-generator/.claude/skills/api-generating/SKILL.md
source content

API Documentation Generator

Generate comprehensive API documentation from source code.

Quick Reference

TaskResource
Identify frameworkSee
PATTERNS.md
Documentation standardsSee
STANDARDS.md
Example outputsSee
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>