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

  3. Use the generated swagger.json

Setuptools Command

This library installs a new command named swagger that is available from the setup.py utility. It runs sphinx to generate the swagger output file. It is similar to running sphinx-build -b swagger except that it has access to your packages metadata so you don’t have to configure it in two places!

This is the recommend approach for using this package.

You can configure the output file name in your project’s setup.cfg in the [swagger] section:

[swagger]
output-file = static/swagger.json

This makes it easier to include it directly into your built artifact by adding it as package_data in setup.py. Remember to add it to your MANIFEST.in as well.

Configuration

This extension contains a few useful configuration values that can be set from within the sphinx configuration file.

swagger_description:

Sets the description of the application in the generated swagger file. If this is not set, then the “description” value in html_theme_options will be used if it is set.

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.

Source Distribution

sphinx-swagger-0.0.4.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

sphinx_swagger-0.0.4-py2.py3-none-any.whl (12.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinx-swagger-0.0.4.tar.gz.

File metadata

File hashes

Hashes for sphinx-swagger-0.0.4.tar.gz
Algorithm Hash digest
SHA256 02a56be438abf079a0f3f8dfefa2435179cb58415b4d3ff6aacb087276fc7ff3
MD5 982bbbc5029a58cac12cf7b3443fb322
BLAKE2b-256 d86b2f4ce2d388049c7e8f76586f785333c2d4af114dadf5a9ae41d5654bf7bd

See more details on using hashes here.

File details

Details for the file sphinx_swagger-0.0.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_swagger-0.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3dffaca8229a5da35d4b6964716dbcac9fb097db12c65e05f4ba878d0e97e3f3
MD5 5b32673136f8af5ff118971a58d5141d
BLAKE2b-256 91293b17ecdff0b60ca8b7995cf6d773d59a27a5272dac3ffb9ed3a9eb7205d2

See more details on using hashes here.

Supported by

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