Skip to main content

Generate markdown API document from Postman.

Project description

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 <figcaption>

    Step One: Select the collection which you wanna export.

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

    Step Two: Find the import button and click it.

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

    Step Three: Export your collection as collection v2.

    </figcaption>
  • 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 details


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 hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page