Supported frameworks
Two editions with the same output: routeman on PyPI for Python APIs, and routeman-cli on npm for Node.js, Bun and Deno APIs. Every guide below includes real routeman output.
Python
pip install routeman · Python 3.9+Django REST framework → Postman
Routers, ViewSets, @action, APIViews and serializers, plus SearchFilter, OrderingFilter, django-filter, pagination and SimpleJWT/Token/Knox auth. You don't need drf-spectacular or drf-yasg.
Django → Postman
URLconf with converters, function and class-based views, ModelForms, request.POST/GET/FILES, json.loads(request.body) and CSRF handled in Postman.
FastAPI → Postman
Pydantic v1/v2 models with valid example values, Query/Form/File/Header, OAuth2 login that stores the token, and hidden routes included.
Flask → Postman
Blueprints, MethodView, Flask-RESTful, flask-smorest and marshmallow, plus body and query fields read from your view code. Works with app factories.
Read the Flask guide →JavaScript & TypeScript
npx routeman-cli · Node.js 18.3+, Bun or DenoExpress → Postman
Routers, app.use() mounts and prefixes, middleware auth, zod / Joi / yup / express-validator bodies, multer uploads, and fields read from req.body and req.query. No swagger-jsdoc.
NestJS → Postman
Controllers, global prefix, URI versioning, class-validator DTOs, mapped types, pipes, FileInterceptor, and guards including APP_GUARD with @Public(). No @nestjs/swagger needed.
Fastify → Postman
Plugins registered with prefixes, @fastify/autoload, JSON Schema and TypeBox bodies and querystrings, schema.summary as request names, and @fastify/jwt hooks.
Next.js API routes → Postman
App Router route.ts handlers with route groups and dynamic segments, Pages Router pages/api, next-connect and basePath, with bodies from zod or request.json().
Everything routeman-cli understands
routeman-cli reads your source files the way the framework would wire them up. It follows imports, routers, mounts, plugins, controllers and decorators, and it never runs your code.
| Framework | What routeman-cli understands |
|---|---|
| Express 4 / 5 | Router(), app.use(prefix, router), router.route().get().post(), sub-apps, router factories, routes registered in loops or loaded with fs.readdirSync/glob, *splat |
| Fastify 4 / 5 | register(plugin, { prefix }), @fastify/autoload (folder prefixes, _param dirs), fastify-plugin, decorate, addHook, route({...}), JSON Schema and TypeBox |
| NestJS | Controllers, global prefix, URI versioning (@Version), RouterModule, DTOs (class-validator and @ApiProperty), PartialType/PickType/OmitType, pipes, FileInterceptor, guards incl. global APP_GUARD and @Public() |
| Koa | @koa/router / koa-router: nesting, prefix, named routes, koa-mount |
| Hono | Sub-apps, route(), basePath(), on(), chained routes, path-scoped middleware, @hono/zod-validator, @hono/zod-openapi |
| Elysia (Bun) | group, guard, plugins, prefix, t.* schemas, .model() references, beforeHandle / derive auth |
| Hapi | server.route, plugins with routes.prefix, Joi validate, auth strategies, auth: false |
| Next.js | App Router route.ts (route groups, dynamic segments), Pages Router pages/api, next-connect, basePath |
| Nuxt / Nitro / h3 | server/api, server/routes, [id].get.ts naming, readBody, getQuery, readValidatedBody, auto-imported utils |
| SvelteKit, Astro, Remix / React Router | +server.ts, API endpoints, resource routes (loader / action) |
| AdonisJS 6 | router.group().prefix().use(), resource().apiOnly(), lazy controllers, VineJS validators, request.input() |
| Decorator frameworks | routing-controllers, tsoa, inversify-express-utils, LoopBack 4 |
| More | Restify, Polka, tinyhttp, ultimate-express, hyper-express, itty-router, Feathers services, Oak (Deno), Bun.serve({ routes }), Deno.serve, plain node:http servers that compare req.url / req.method |
| Anything else | --openapi <file or URL> builds the collection from an OpenAPI 3 / Swagger 2 document (JSON or YAML) |
Request bodies come from zod (v3/v4), Joi / celebrate, yup, TypeBox / Elysia t, valibot, VineJS, express-validator, JSON Schema, class-validator DTOs, TypeScript types, Mongoose / Prisma / Sequelize / TypeORM models when the body goes straight to the database, and finally the handler code itself. Read the Node.js docs →