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.

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 apidoc.md.j2 for your project.

Installation

$ pip install apidoc2markdown

Usage

usage: apidoc2markdown-script.py [-h] [-i APIDOC_LOCATION] [-o OUTPUT]
                                [-t TEMPLATE]

optional arguments:
  -h, --help            show this help message and exit
  -i APIDOC_LOCATION, --input APIDOC_LOCATION
                        path to the directory with api_data.json
                        and api_project.json (default: .)
  -o OUTPUT, --output OUTPUT
                        path to the output Markdown file (default: swagger.md)
  -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.

Files for apidoc2markdown, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size apidoc2markdown-0.1.0-py3-none-any.whl (5.5 kB) File type Wheel Python version 3.5 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page