Settings

The configuration of Django REST Swagger is identical to Django REST Framework. Settings are configurable in settings.py by defining SWAGGER_SETTINGS.

Example:

settings.py

SWAGGER_SETTINGS = {
    'SECURITY_DEFINITIONS': {
        'basic': {
            'type': 'basic'
        }
    },
    ...
}

Authentication

USE_SESSION_AUTH

Toggles the use of Django Auth as an authentication mechanism. Setting it to True will display a login/logout button on the Swagger UI and post csrf_tokens to the API.

Default: True

Note: The login/logout button relies on the LOGIN_URL and LOGOUT_URL settings which default to /accounts/login. These can either be configured under SWAGGER_SETTINGS or Django settings.

urls.py

urlpatterns = [
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

settings.py

LOGIN_URL = 'rest_framework:login'
LOGOUT_URL = 'rest_framework:logout'

LOGIN_URL

The URL to use to log in session authentication. Accepts named URL patterns.

Default: django.conf.settings.LOGIN_URL

LOGOUT_URL

The URL to use to log out of session authentication. Accepts named URL patterns.

Default: django.conf.settings.LOGOUT_URL

SECURITY_DEFINITIONS

The security definitions configures which authentication methods can be used by Swagger. The schemes types currently supported by the OpenAPI 2.0 spec are basic, apiKey and oauth2.

For more information on available options, please consult the OpenAPI Security Object Definition.

Default:

{
    'basic': {
        'type': 'basic'
    }
}

Headers

ACCEPT_HEADER_VERSION

Use this setting if you are using the AcceptHeaderVersioning version scheme and require a value to interact with the API.

Default: None

E.g.: Setting to 1.0 will modify the HTTP Accept header from application/json to application/json; version=1.0.

For further customization, use the CUSTOM_HEADERS.

CUSTOM_HEADERS

Define a dictionary of values to be passed as HTTP headers in all API requests.

Default: {}

All key/val provided in this dictionary will be set on the request headers for all API requests.

SwaggerUI Settings

Below are some basic configuration settings for SwaggerUI. Note that for more advanced use cases, you may wish to write your own rest_framework_swagger/static/init.js file.

APIS_SORTER

Set to alpha to enable alphabetical sorting.

Default: None

DOC_EXPANSION

Controls how the API listing is displayed. It can be set to:

• None: All operations are collapsed
• "list": Lists all the operations
• "full": Expands all the operations

Default: None

JSON_EDITOR

Enables a graphical view for editing complex bodies.

Default: False

OPERATIONS_SORTER

Sorts the operation list of each API. It can be set to:

• alpha: Sort alphabetically
• method: Sort by HTTP method

Default: None

SHOW_REQUEST_HEADERS

Set to True to display the request headers.

Default: False

SUPPORTED_SUBMIT_METHODS

A list of HTTP methods can be interacted with using the "Try it out!" button.

Default: ['get', 'post', 'put', 'delete', 'patch']

VALIDATOR_URL

URL to swagger.io's online schema validator. Can be modified to point to a local install, or set to None to disable.

Default: https://online.swagger.io/validator/