Converter from Swagger JSON to Markdown.
Project description
Swagger is an open specification for documenting REST APIs in JSON or YAML. Imperfect as it is, it’s de facto a standard for many API developers.
This extension lets you render your swagger.json file as a Markdown document. You can customize the output by providing your own Jinja2 template.
Installation
$ pip install swagger2markdownUsage
usage: swagger2markdown [-h] [-i SWAGGER_LOCATION] [-a SWAGGER_LOCATION]
[-o OUTPUT] [-t TEMPLATE] [-v]
optional arguments:
-h, --help show this help message and exit
-i SWAGGER_LOCATION, --input SWAGGER_LOCATION
path to or URL of the Swagger JSON file (default:
swagger.json)
-a SWAGGER_LOCATION, --additional SWAGGER_LOCATION
path to or URL of an complementary Swagger JSON file
-o OUTPUT, --output OUTPUT
path to the output Markdown file (default: swagger.md)
-t TEMPLATE, --template TEMPLATE
Jinja2 template used for conversion
-v, --version show program's version number and exitThe content of the additional Swagger file is merged into the main file. It does not overwrite values in the main file, only fills in the missing ones.
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for swagger2markdown-0.1.9-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d2e5100e9afbec24b1e52fed18c73a3187528141680b38a0004e1ff5328f7b88 |
|
| MD5 | 1efac0024fcfe415defb61bb8ec7fd72 |
|
| BLAKE2b-256 | 1d590a7db34f55dac22c54a94cddf1ea3c2bbf5428797a83a8590844208fee4e |
