Skip to main content

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 swagger2markdown

Usage

usage: swagger2markdown-script.py [-h] [-i SWAGGER_LOCATION] [-o OUTPUT]
                                [-t TEMPLATE]

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

swagger2markdown-0.1.6-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file swagger2markdown-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for swagger2markdown-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b556552538b7abf547bfbe099df4c806509441ba42fc32fbbe827f66d804cbe7
MD5 3f0665d7b7044984c6a0e50caa4f5c1b
BLAKE2b-256 26cd099d967706cad67a0c8c7572a75b48d97ff1c275116a04d5fa9307c10036

See more details on using hashes here.

Supported by

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