falcon-swagger-ui 1.1.0

Swagger UI Application for Falcon

Simple Falcon application for adding Swagger UI to your falcon application.

Included Swagger UI version: v3.10.0

Installation

pip install falcon-swagger-ui

Usage

Example application:

import falcon
from falcon_swagger_ui import register_swaggerui_app

SWAGGERUI_URL = '/swagger'  # without trailing '/'
SCHEMA_URL = 'http://petstore.swagger.io/v2/swagger.json'
"""
# For developer environment you can expose a static endpoint like:
from falcon_swagger_ui import StaticSinkAdapter

SCHEMA_URL = '/v2/swagger.json'

app.add_sink(
    StaticSinkAdapter('path/to/your/swagger/schema.json'), SCHEMA_URL
)

"""

app = falcon.API()

page_title = 'Falcon Swagger Doc'  # defaults to Swagger UI
favicon_url = 'https://falconframework.org/favicon-32x32.png'  # defaults to Swagger Favicon
register_swaggerui_app(
    app, SWAGGERUI_URL, SCHEMA_URL,
    page_title=page_title,
    favicon_url=favicon_url,
    config={'supportedSubmitMethods': ['get'], }
)

Running the example application:

pip install falcon gunicorn jinja2
gunicorn example:app

Configuration

The application supports overloading all Swagger UI configuration options that can be JSON serialized. See https://github.com/swagger-api/swagger-ui#parameters for options.

In addition, some of the OAuth fields are exposed to special variables that will be rendered into the relevant function.

Application defaults are listed below (should match SwaggerUI defaults).

{
        # OAuth related
        'app_name': 'null',
        'client_realm': 'null',
        'client_id': 'null',
        'client_secret': 'null',

        # SwaggerUI base configuration, see https://github.com/swagger-api/swagger-ui#parameters
        'docExpansion': "none",
        'jsonEditor': False,
        'defaultModelRendering': 'schema',
        'showRequestHeaders': False,
        'supportedSubmitMethods': ['get', 'post', 'put', 'delete', 'patch']
}