Skill1.1k repo starsupdated 3mo ago

route-scanning

Route-scanning analyzes Express.js source directories to extract all API route definitions, including HTTP methods, paths, file locations, line numbers, applied middleware, and route type classifications. Use this skill when building API documentation, generating route inventories, or preparing route data for downstream processing pipelines that require structured endpoint information.

View source Repository: claude-code-engineering

Install in Claude Code

Copy

git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering /tmp/route-scanning && cp -r /tmp/route-scanning/04-Skills/projects/08-skill-pipeline/.claude/skills/route-scanning ~/.claude/skills/route-scanning

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

Definition

SKILL.md

# Route Scanning Skill

Discover all API route definitions in Express.js source files.

## Process

### Step 1: Run Route Scanner

Execute the scanning script:

```bash
python3 scripts/scan-routes.py <source_directory>
```

The script outputs a structured route list with method, path, file, and line number.

### Step 2: Enrich Route Data

For each discovered route, also identify:
- Middleware applied (auth, validation, etc.)
- Whether it's a standard route or chained route (`router.route()`)

### Output Format

Return a JSON-compatible route manifest:

```json
[
  {
    "method": "GET",
    "path": "/api/products",
    "file": "src/routes/products.js",
    "line": 8,
    "middleware": ["requireAuth"],
    "type": "standard"
  }
]
```

This manifest will be consumed by the next pipeline stage (doc-writing).