FastAPI APIs to Postman collections
Project description
A tool that creates a Postman collection from a FastAPI application.
Inspired from flask2postman
Install
$ pip install fastapi2postman
Example
Let’s say that you have a FastAPI project called “app.py” and you want to generate a Postman collection out of it.
You just need to tell fastapi2postman
$ fastapi2postman --app app.py
If you want to change the name of the output file use –output flag, the default name is ofcousre output.json
$ fastapi2postman --app app.py --output output.json
This will generate the JSON configuration, and write it into the
output.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: fastapi2postman [-h] [--output OUTPUT] [--name NAME] [--host HOST]
[--port PORT] --app APP
- optional arguments:
- -h, --help
show this help message and exit
- --output OUTPUT
Output file
- --name NAME
Collection name
- --host HOST
API host
- --port PORT
API port
- --app APP
Path to FastAPI application instance
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fastapi2postman-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10589335ced59349dafd3c2eef7189eb4f4687a95204ca351fdb279966e26616 |
|
MD5 | 4805ffcef5e07fbb30cc14916475793c |
|
BLAKE2b-256 | ffdbb2485bf0eb97d1782a4a7e92c25af552fb23622036a061d1c74cf9920936 |