sphinxcontrib-swaggerui 0.1.0

Provides the swaggerui directive for reST files to build an interactive HTML page with your OpenAPI specification document.

Provides the swaggerui directive for reST files to build a driven by Swagger-UI interactive panel presenting your OpenAPI specification document.

---

Sphinx Directive swaggerui

Installation

$ pip install sphinxcontrib-swaggerui

Configuration

In your project conf.py, add the installed extension:

extensions = [...,
    'sphinxcontrib.swaggerui',
    ...]

The directive also implies that you use the static content in the _static/ folder and this is configured as:

html_static_path = ['_static']

Directive in reST Files

Use the following sample configuration when testing the directive for the first time:

.. swaggerui:: ../_static/swaggerui/petstore.yaml                                 # *) Required
   :url: https://unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js                 # *) Required
   :css: ../_static/swaggerui/swagger-ui.css                                      # *) Required
   :script: https://unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js   # Optional
   :filter: pets                                                                   # Optional

The attribute (for example, ../_static/swagger/petstore.yaml) refers to your local YAML or JSON file in the OpenAPI format. The path must be relative to the document containing this directive.

The directive uses the following options:

• url refers to a CDN-based (Content Delivery Network) Swagger-UI package. For a proper version of the script, refer to the UNPKG CDN. The script name must be swagger-ui-bundle.js.
• css refers to a local Swagger-UI CSS file. The path must be relative to the document containing the directive. You can find a proper CSS file in the UNPKG CDN.
• script refers to the additional script (the one in the above example is recommended). For a proper version of the script, refer to the UNPKG CDN. The script name must be swagger-ui-standalone-preset.js. Probably, you will find another script that can work with the main Swagger-UI script specified by the :url: option.
• filter requires Swagger UI to display only those endpoints (paths) which contain a tag that partially or fully matches the filter.

This package contains petstore.yaml and swagger-ui.css files (mentioned in the above example) copied to the _static/swaggerui/ folder during the first use of the directive by Sphinx. So don't care about copying these files when you specify the relative path to that folder; the sample files will appear automatically in it whether you use them or not.

Sample CSS Customization

Avoid the operation block tag to disappear:

h4.opblock-tag a.nostyle {
    opacity: 1
}

Remove the Swagger top-bar:

.swagger-ui .topbar {
    display: none;
}

More complex customization that removes all headers leaving only the list of operations: GET, PUT, etc. - and does some other makeups:

/* Editing Swagger UI styles */

.topbar, .information-container, .scheme-container, .operation-filter-input, .try-out, .response-controls, .opblock-tag {
  display: none!important;
}

.swagger-ui .response-col_description {
  width: 75%!important;
}

.swagger-ui .response-col_links {
  max-width: 100em;
}

.swagger-ui.swagger-container {
  padding-top: 5px;
  background-color: #EEF1F6;
}

This is how a section looks like with the above CSS:


Links

• Source: Bitbucket