Python Version PyPI version

Generate markdown API document from Postman.

Installation

pip install postdown

Usage

  • Export JSON from postman

    Export your collection from Postman(Only support to Collection v2 for now). You could get a JSON file.

    https://raw.githubusercontent.com/TitorX/Postdown/master/imgs/step-1.png

    Step One: Select the collection which you wanna export.

    https://raw.githubusercontent.com/TitorX/Postdown/master/imgs/step-2.png

    Step Two: Find the import button and click it.

    https://raw.githubusercontent.com/TitorX/Postdown/master/imgs/step-3.png

    Step Three: Export your collection as collection v2.

  • Run postdown to generate markdown document:

    postdown xxx.json xxx.md

And you will get your API document which is markdown formatting.

Click here to see an example generated.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for titor from gravatar.com titor

Credits

Author: Titor

Report project as malware

Download files

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

Source Distribution

Postdown-1.0.11.tar.gz (15.7 kB view details)

Uploaded Source

File details

Details for the file Postdown-1.0.11.tar.gz.

File metadata

  • Download URL: Postdown-1.0.11.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Postdown-1.0.11.tar.gz
Algorithm Hash digest
SHA256 2a046b1ef32a2c741fd49d3a12cd04d6e88374971022b11ac7da37872fb8a0ed
MD5 1bd140a7d2d11c754e62c209b5485b68
BLAKE2b-256 8ed0c04fe982d0b1b1a4a7e1868631a499e8f4ad87904c320aa91e589e521ff1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page