routeman-cli

routeman

Generate a complete Postman collection from your Node.js, Bun or Deno API with one command. Works with Express, Fastify, NestJS, Koa, Hono, Elysia, Hapi, Next.js, Nuxt, SvelteKit, AdonisJS and more. You don't need OpenAPI, Swagger decorators or a running server.

npx routeman-cli        # or: pnpm dlx routeman-cli · yarn dlx routeman-cli · bunx routeman-cli · deno run -A npm:routeman-cli

✓ express: 24 requests (9 GET, 8 POST, 3 PUT, 2 PATCH, 2 DELETE)
✓ auth: bearer (login: POST /api/v1/auth/login)
✓ wrote postman/shop-api.postman_collection.json
✓ wrote postman/shop-api.local.postman_environment.json
  done in 0.08s - import the files in Postman (File → Import)

routeman reads your source code the way the framework would wire it up. It follows imports, routers, app.use() mounts, prefixes, plugins, controllers and decorators. It never runs your code, so it doesn't need a database, secrets or a build step, and it can't trigger side effects. You get every endpoint with its methods, path variables, query parameters and request bodies, all filled with example values that pass your validation. You also get authentication setup and a login request that saves the token for you.

Made by Shwastik Tech Solutions Pvt Ltd. Also available for Python (Django, Flask, FastAPI): pip install routeman.

Install

Once installed, the command is routeman (for example npx routeman routes, or a "postman": "routeman" script).

Requires Node.js 18.3 or newer (or Bun or Deno). Zero dependencies: the package is about 600 kB and installs in about a second.

Supported frameworks

What you get

Commands

routeman                       # same as `routeman generate`
routeman generate --stdout     # print the collection instead of writing files
routeman routes                # list what routeman found (method, path, auth, body fields)
routeman routes --json         # machine-readable
routeman init                  # save the project details in routeman.config.json (asks a few questions)
routeman --version

Configuration file

routeman init writes routeman.config.json. You can put the same object under "routeman" in package.json instead:

{
  "name": "Shop API",
  "framework": "auto",
  "entry": ["src/server.ts"],
  "output": "postman",
  "environments": {
    "local": "http://localhost:3000",
    "production": "https://api.example.com"
  },
  "exclude": ["^/internal/"],
  "auth": { "type": "auto", "login": "/api/auth/login" }
}

Command-line options override the file.

Programmatic API

import { generate, write } from 'routeman-cli';

const result = await generate({ project: '.', environments: { staging: 'https://staging.example.com' } });
console.log(result.api.routes.length, 'routes');
write(result); // or use result.collection / result.environments directly

Types are included (index.d.ts).

How it works

routeman parses your files with a vendored copy of the Babel parser (JavaScript, TypeScript, JSX, decorators). It then runs a small abstract interpreter over them. This interpreter evaluates imports (ESM, CommonJS, tsconfig paths, package.json imports, Deno import maps), string constants, process.env values from .env, function calls, classes and loops over static arrays. It records every router and route the framework would register. It never executes anything outside your source files, never touches the network or a database, and has a hard step budget, so it always finishes fast. Each handler is then analysed with symbolic request values to see what it reads.

It is fast and light: about 3,000 routes in 0.8 s. Memory use stays flat over repeated runs in the same process, because there are no global caches, timers or listeners.

Tips

• Set username / password in the environment, run Login first, and the token is used everywhere.
• Set the {{…Id}} variables from list responses, or edit them in the environment.
• Regenerate whenever your API changes. Collection and request ids are stable, so importing again replaces the previous version.
• If routes are missing, run routeman routes and check the warnings. Usually the entry file needs to be passed with --entry, or a route path is built at runtime from data routeman can't see.

Testing

npm test runs the unit tests and checks 17 realistic sample projects (one per framework) against hand-written expectations. npm run test:e2e <project> starts the real server of a sample project and sends every generated request to it. Every request must be accepted: no 5xx, no 404, no validation error and no auth failure.

License

MIT © Shwastik Tech Solutions Pvt Ltd