flask2postman
A tool that creates a Postman collection from a Flask application.
Install
$ pip install flask2postman
Example
Let's say that you have a Flask project called "example" (see example.py), and you want to generate a Postman collection out of it.
You just need to tell flask2postman how to import the Flask instance, and optionally give a name to the Postman collection:
$ flask2postman example.app --name "Example Collection" --folders > example.json
If you don't have a global Flask instance but rather use a function to initialize your application, that works too:
$ flask2postman example.create_app --name "Example Collection" --folders > example.json
This will generate the JSON configuration, and write it into the example.json file. You can then import this file into Postman ("Import Collection" button), and profit:
On a side note, you can see that endpoint's docstrings are automatically imported as descriptions.
Usage
usage: flask2postman [-h] [-n NAME] [-b BASE_URL] [-a] [-i] [-f]
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
-s, --static also generate /static/{{filename}} (Flask internal)
-i, --indent indent the output
-f, --folders add Postman folders for blueprints
License
MIT
10 Nov 24, 2022
3.9k Dec 29, 2022
3 Jan 15, 2022
365 Jan 06, 2023
9 May 29, 2021
48 Mar 07, 2022
1.3k Jan 05, 2023
718 Dec 20, 2022
39 Jul 03, 2022
2.2k Jan 04, 2023
5 Dec 19, 2022
1 Dec 01, 2022
204 Dec 26, 2022
3 Jul 03, 2022
11 Dec 27, 2022
0 Oct 17, 2022
209 Jan 05, 2023
397 Dec 15, 2022
6 Nov 07, 2021
0 Jul 11, 2021