# API Generating

Generate API endpoint code and documentation from specifications.

- Repository: https://github.com/huangjia2019/claude-code-engineering (1147 stars)
- Category: Writing
- License: see repository
- Last updated: 2026-07-23
- Runs scripts: yes, review before use

## Install

Claude Code: `npx skills add huangjia2019/claude-code-engineering --skill api-generating -g -a claude-code -y`
Codex: `npx skills add huangjia2019/claude-code-engineering --skill api-generating -g -a codex -y`
Cursor: `npx skills add huangjia2019/claude-code-engineering --skill api-generating -g -a cursor -y`
Gemini CLI: `npx skills add huangjia2019/claude-code-engineering --skill api-generating -g -a gemini-cli -y`

## Description

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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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:
```bash
python scripts/detect_routes.py <source_directory>
```

To validate OpenAPI spec:
```bash
./scripts/validate_openapi.sh <spec_file>
```