Generate markdown API document from Postman.
Project description
YspPostdown
|Python Version| |PyPI version|
*Generate markdown API document from Postman.*
Installation
.. code:: shell
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.
.. figure:: https://raw.githubusercontent.com/YangShuiPing/YspPostdown/master/imgs/step-1.png
Step One: Select the collection which you wanna export.
.. figure:: https://raw.githubusercontent.com/YangShuiPing/YspPostdown/master/imgs/step-2.png
Step Two: Find the import button and click it.
.. figure:: 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. <https://github.com/YangShuiPing/YspPostdown/tree/master/demo>
_
.. |Python Version| image:: https://img.shields.io/badge/python-2&3-brightgreen.svg?style=flat-square :target: https://pypi.python.org/pypi/YspPostdown .. |PyPI version| image:: https://img.shields.io/pypi/v/YspPostdown.svg?style=flat-square :target: https://pypi.python.org/pypi/YspPostdown
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ysp_postdown-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21f2c2a7c68dcd59172902bdde03c2906191e6a3d6b82bd32f1ecd89e9767cb0 |
|
MD5 | 7fb4193acccc1fc8cc915310a208a6b5 |
|
BLAKE2b-256 | bd8346b6a36712793ba19229e0267e118feeba43509421b250fd26e84e22ccae |