An open API service indexing awesome lists of open source software.

https://github.com/funnyhcat-dotcom/route-map-lite

Scan source code and generate a simple API route map.
https://github.com/funnyhcat-dotcom/route-map-lite

api cli developer-tools express fastify markdown nextjs nodejs routes

Last synced: 1 day ago
JSON representation

Scan source code and generate a simple API route map.

Awesome Lists containing this project

README

          

# route-map-lite

Scan source code and generate a simple API route map.

Use it to understand a codebase quickly, document API endpoints, review route changes, or create a `ROUTES.md` table for a README.

## Quick start

```bash
npx route-map-lite .
```

```bash
# JSON for automation
npx route-map-lite src --format json

# write docs
npx route-map-lite . --output ROUTES.md
```

## Detects

- Express-style `app.get('/path')`, `router.post('/path')`
- Fastify `fastify.get('/path')`
- Fastify `fastify.route({ method, url })`
- Next.js Pages API files under `pages/api`
- Next.js App Router API files under `app/api/**/route.ts`

## Example output

| Method | Path | Framework | Source |
|---|---|---|---|
| GET | `/health` | express | server.js:3 |
| POST | `/users` | express | server.js:4 |

## License

MIT