Skip to content

Generate markdown API document from Postman.

License

Notifications You must be signed in to change notification settings

askme-gpt/YspPostdown

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

YspPostdown

Python Version PyPI version

Generate markdown API document from Postman.

Installation

pip install ysp_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/YangShuiPing/YspPostdown/master/imgs/step-1.png

    Step One: Select the collection which you wanna export.

    https://raw.githubusercontent.com/YangShuiPing/YspPostdown/master/imgs/step-2.png

    Step Two: Find the import button and click it.

    https://raw.githubusercontent.com/YangShuiPing/YspPostdown/master/imgs/step-3.png

    Step Three: Export your collection as collection v2.

  • Run ysp_postdown to generate markdown document:

    ysp_postdown xxx.json xxx.md
    

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

Click here to see an example generated.

About

Generate markdown API document from Postman.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.5%
  • Shell 0.5%