Skip to main content

flask2postman

Project description

A tool that creates a Postman collection from a Flask application.

Install

$ pip install flask2postman

Example

We have a Flask project called “example”, (see example.py), and we want to generate a Postman collection out of it.

We just need to tell flask2postman how to import the Flask instance, and optionally give a name to the collection:

$ flask2postman example.app --name "Example Collection" > example.json

This will generate the JSON configuration, and write it into the example.json file.

Then we just have to import this file into Postman (“Import Collection” button, left panel, top right), and profit:

Postman screenshot

Usage

usage: flask2postman [-h] [-n NAME] [-b BASE_URL] [-a] flask_instance

positional arguments:
  flask_instance

optional arguments:
  -h, --help            show this help message and exit
  -n NAME, --name NAME  Postman collection name (default: current directory
                        name)
  -b BASE_URL, --base_url BASE_URL
                        the base of every URL (default: {{base_url}})
  -a, --all             also generate OPTIONS/HEAD methods

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask2postman-1.1.0.tar.gz (4.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page