Skip to main content

Generate swagger definitions from sphinx docs

Project description

Generates a swagger API definition directly from httpdomain based documentation.

Usage

  1. Enable the extension in your conf.py by adding 'sphinxswagger' to the extensions list
  2. Run the swagger builder (e.g., setup.py build_sphinx -b swagger)
  3. Use the generated swagger.json

Configuration

This extension contains a few useful configuration values:

swagger_file:Sets the name of the generated swagger file. The file is always generated in the sphinx output directory – usually build/sphinx/swagger. The default file name is swagger.json.
swagger_license:
 A dictionary that describes the license that governs the API. This is written as-is to the License section of the API document. It should contain two keys – name and url.

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 sphinx-swagger, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_swagger-0.0.2-py3-none-any.whl (7.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinx-swagger-0.0.2.tar.gz (5.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page