Skill828 repo starsupdated 13d ago

api-documenting

The api-documenting skill generates comprehensive API documentation by extracting endpoint information from source code, including HTTP methods, routes, parameters, schemas, and authentication requirements. Use this skill when documenting REST APIs, creating API references, generating endpoint documentation, or producing OpenAPI/Swagger specifications for both markdown and specification formats.

View source Repository: claude-code-engineering

Install in Claude Code

Copy

git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering /tmp/api-documenting && cp -r /tmp/api-documenting/04-Skills/projects/02-progressive-skill ~/.claude/skills/api-documenting

Then start a new Claude Code session; the skill loads automatically.

Definition

SKILL.md

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

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