Metadata-Version: 2.0
Name: swagger2markdown
Version: 0.1.9
Summary: Converter from Swagger JSON to Markdown.
Home-page: https://github.com/moigagoo/swagger2markdown
Author: Konstantin Molchanov
Author-email: moigagoo@live.com
License: MIT
Download-URL: https://pypi.org/project/swagger2markdown
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Dist: Jinja2
Requires-Dist: requests

################
swagger2markdown
################

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.

.. _Swagger: http://swagger.io/
.. _Jinja2: http://jinja.pocoo.org/


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

.. _swagger.md.j2: https://github.com/moigagoo/swagger2markdown/blob/master/swagger.md.j2


************
Installation
************

.. code-block:: shell

    $ pip install swagger2markdown


*****
Usage
*****

.. code-block:: shell

    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 exit

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


