postdown / Postdown

Generate markdown API document from Postman.

Postdown

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.

  

  Step One: Select the collection which you wanna export.

  

  Step Two: Find the import button and click it.

  

  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.