A tool that creates a Postman collection from a FastAPI application.
Inspired from flask2postman
Install
$ pip install fastapi2postmanExample
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.pyIf 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.jsonThis 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
1 maintainer
Metadata
1 maintainer
Release files for fastapi2postman 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fastapi2postman-0.1.2.tar.gz | 4.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastapi2postman-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.2 kB
Release files / fastapi2postman-0.1.2.tar.gz
| Download URL | fastapi2postman-0.1.2.tar.gz |
|---|---|
| Size | 4.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6224261b8f67cd0600da10ca8b4e6dd741138438dc7009fdb897a7c74299cd99
|
|
BLAKE2b-256 checksum How to use checksums |
dad21c68c0a785bba4ce4867862173f11c749f012b62d841b1939500376d715a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / fastapi2postman-0.1.2-py3-none-any.whl
| Download URL | fastapi2postman-0.1.2-py3-none-any.whl |
|---|---|
| Size | 4.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
10589335ced59349dafd3c2eef7189eb4f4687a95204ca351fdb279966e26616
|
|
BLAKE2b-256 checksum How to use checksums |
ffdbb2485bf0eb97d1782a4a7e92c25af552fb23622036a061d1c74cf9920936
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Security for fastapi2postman 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
