routeman

Generate a complete Postman collection from your Django, Django REST framework, Flask or FastAPI project with one command. You don't need OpenAPI, drf-spectacular, flasgger or any other documentation library.

pip install routeman
cd your-project
routeman generate

✓ django: 24 requests (11 GET, 9 POST, 2 PUT, 1 PATCH, 1 DELETE), 1 websocket(s)
✓ auth: bearer (login: POST /api/v1/auth/token/)
✓ wrote postman/your-project-api.postman_collection.json
✓ wrote postman/your-project-api.local.postman_environment.json
  done in 0.26s - import the files in Postman (File → Import)

routeman loads your application the same way your server does and reads its real routes. You get every endpoint with its methods, path variables, query parameters and request bodies filled with working example values, plus authentication and a login request that saves the token for you. Import the two files into Postman and start sending requests.

Made by Swastik Tech Solutions Pvt Ltd.

What you get

How it reads your project (no schema needed)

When a view declares no serializer, form or schema, routeman reads the view's source code to find the fields it uses, for example request.data.get('email'), data['name'], int(request.data.get('age', 0)) or request.args.get('page', type=int). Those requests are marked so you know the list was inferred.

Commands

routeman generate                 # write postman/<name>.postman_collection.json + environments
routeman generate --stdout        # print the collection instead
routeman routes                   # list what routeman found (method, path, auth, body fields)
routeman init                     # save the project details in routeman.toml (asks a few questions)
routeman --version

Useful options (all optional; routeman detects everything it can):

Configuration file

routeman init writes routeman.toml. You can also put the same table under [tool.routeman] in pyproject.toml:

[routeman]
name = "Shop API"
framework = "django"
app = "shop.settings"          # Flask/FastAPI: "main:app" or "factory:create_app()"
output = "postman"
exclude = ["^/internal/"]

[routeman.environments]
local = "http://localhost:8000"
production = "https://api.example.com"

[routeman.auth]
type = "auto"                  # auto | none | bearer | token | basic | apikey | session
login = "/api/token/"          # optional: detected automatically
# prefix = "JWT"               # Authorization: JWT <token>
# header = "X-API-Key"         # header for apikey auth

Command-line options override the file.

Requirements

• Python 3.9 or newer, with no dependencies besides tomli on Python < 3.11.
• Run routeman from the virtualenv your project runs in, because it imports your app to read the routes. Importing is read-only: routeman never touches your database or sends requests.
• If your settings need environment variables, keep them in .env (loaded automatically) or pass --env-file.

Tested with Django 3.2 to 6, Django REST framework 3.12+, Flask 2.0 to 3.x, FastAPI 0.95+ with Pydantic v1 and v2.

Tips

• Run Login first in Postman. The token is stored and sent with every other request.
• Set the {{…_id}} variables in the environment from list responses, or edit the request.
• Django form views (session/CSRF): send any GET first so Postman receives the csrftoken cookie. The collection copies it into the X-CSRFToken header for you.
• Regenerate whenever your API changes. Collection and request ids are stable, so importing again replaces the previous version.

License

MIT © Swastik Tech Solutions Pvt Ltd