swagger2markdown 0.1.0

Converter from Swagger to Markdown.

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.

Warning

This extension was created for a particular project and thus is only guaranteed to work with this particular project! It is very much likely you’ll have to modify swagger.md.j2 for your project.

Installation

$ pip install swagger2markdown

Usage

usage: swagger2markdown [-h] [-i] [-o] [-t]

optional arguments:
  -h, --help        show this help message and exit
  -i , --input      path to or URL of the Swagger JSON file (default: swagger.json)
  -o , --output     path to the output Markdown file (default: swagger.md)
  -t , --template   Jinja2 template used for conversion