Skip to main content

Sphinx extension for documenting Swagger 2.0 APIs

Project description

Sphinx extension for documenting Swagger 2.0 APIs

Usage

Include extension in conf.py

extensions = ['sphinxcontrib.swaggerdoc']

Add directive pointing to Swagger api-docs

.. swaggerv2doc:: URL/swagger.json

For example

.. swaggerv2doc:: http://petstore.swagger.io/v2/swagger.json

If the Swagger description contains multiple tags, you can select a subset for the documentation generation. For example, the following directive only generates the documentation for the methods contained in tags pet and store.

.. swaggerv2doc:: http://petstore.swagger.io/v2/swagger.json
   pet
   store

Note

The old directive for Swagger 1.0 is still usable. For example,

.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/pet
.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/user
.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/store

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 sphinxcontrib-swaggerdoc, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_swaggerdoc-0.1.2-py2-none-any.whl (6.5 kB) File type Wheel Python version py2 Upload date Hashes View hashes

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page