Skip to main content

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.

Release files for Postdown 1.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Postdown 1.0.11
File Size Uploaded
Postdown-1.0.11.tar.gz 15.7 kB Details

Release files / Postdown-1.0.11.tar.gz

Download URL Postdown-1.0.11.tar.gz
Size 15.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2a046b1ef32a2c741fd49d3a12cd04d6e88374971022b11ac7da37872fb8a0ed
BLAKE2b-256 checksum
How to use checksums
8ed0c04fe982d0b1b1a4a7e1868631a499e8f4ad87904c320aa91e589e521ff1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.11 This release

1 release file

1.0.10

1 release file

1.0.9

1 release file

1.0.8

1 release file

1.0.7

1 release file

1.0.6

1 release file

1.0.5

1 release file

1.0.4

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page