Skip to main content

Converter from Swagger to Sphinx HTTP domain.

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 Sphinx document. It uses HTTP domain directives for paths and a glossary for definitions.

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-api.rst for your project.

Usage

  1. Install the extension:

    $ pip install sphinxcontrib-swagger2sphinx
    
  2. Copy the content of swagger-api.rst to the file where you want your Swagger file rendered.

  3. Add the extension to your conf.py:

    extensions = [
        'sphinxcontrib.swagger2sphinx',
        ...
    ]
    
  4. Specify the path to your Swagger file in conf.py. It can be a local path or a URL:

    swagger2sphinx_swagger_location = "swagger.json"
    # swagger2sphinx_swagger_location = "http://example.com/swagger.json"
    

Testimonials

Thanks to Eric Holscher for writing an excellent blog post about extending Sphinx with Jinja2 templating.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_swagger2sphinx-0.1.4-py3-none-any.whl (4.7 kB) Copy SHA256 hash SHA256 Wheel 3.5 Oct 7, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page