Documentation
README
Route Scanning Skill
Discover all API route definitions in Express.js source files.
Process
Step 1: Run Route Scanner
Execute the scanning script:
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:
[
{
"method": "GET",
"path": "/api/products",
"file": "src/routes/products.js",
"line": 8,
"middleware": ["requireAuth"],
"type": "standard"
}
]
This is the opening of the README. Read the full README on GitHub.