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

    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.

Supported by

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