Skip to main content

Converter from Apidoc JSON to Markdown.

Project description

Apidoc 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.


$ pip install apidoc2markdown


usage: [-h] [-i APIDOC_LOCATION] [-o OUTPUT]
                                [-t TEMPLATE]

optional arguments:
  -h, --help            show this help message and exit
                        path to the directory with api_data.json
                        and api_project.json (default: .)
  -o OUTPUT, --output OUTPUT
                        path to the output Markdown file (default:
  -t TEMPLATE, --template TEMPLATE
                        Jinja2 template used for conversion

Project details

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

apidoc2markdown-0.1.0-py3-none-any.whl (5.5 kB view hashes)

Uploaded 3 5

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page