Settings¶

Settings are configurable in settings.py by defining SWAGGER_SETTINGS or REDOC_SETTINGS.

Example:

settings.py

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

REDOC_SETTINGS = {
   'LAZY_RENDERING': True,
   ...
}

The possible settings and their default values are as follows:

`SWAGGER_SETTINGS`¶

Default classes¶

DEFAULT_AUTO_SCHEMA_CLASS¶

ViewInspector subclass that will be used by default for generating Operation objects when iterating over endpoints. Can be overriden by using the auto_schema argument of @swagger_auto_schema or by a swagger_schema attribute on the view class.

Default: drf_yasg.inspectors.SwaggerAutoSchema

DEFAULT_FIELD_INSPECTORS¶

List of FieldInspector subclasses that will be used by default for inspecting serializers and serializer fields. Field inspectors given to @swagger_auto_schema will be prepended to this list.

Default: [
'drf_yasg.inspectors.CamelCaseJSONFilter',
'drf_yasg.inspectors.ReferencingSerializerInspector',
'drf_yasg.inspectors.RelatedFieldInspector',
'drf_yasg.inspectors.ChoiceFieldInspector',
'drf_yasg.inspectors.FileFieldInspector',
'drf_yasg.inspectors.DictFieldInspector',
'drf_yasg.inspectors.SimpleFieldInspector',
'drf_yasg.inspectors.StringDefaultFieldInspector',
]

DEFAULT_FILTER_INSPECTORS¶

List of FilterInspector subclasses that will be used by default for inspecting filter backends. Filter inspectors given to @swagger_auto_schema will be prepended to this list.

Default: [
'drf_yasg.inspectors.CoreAPICompatInspector',
]

DEFAULT_PAGINATOR_INSPECTORS¶

List of PaginatorInspector subclasses that will be used by default for inspecting paginators. Paginator inspectors given to @swagger_auto_schema will be prepended to this list.

Default: [
'drf_yasg.inspectors.DjangoRestResponsePagination',
'drf_yasg.inspectors.CoreAPICompatInspector',
]

Authorization¶

USE_SESSION_AUTH¶

Enable/disable Django login as an authentication/authorization mechanism. If True, a login/logout button will be displayed in Swagger UI.

Default: True

LOGOUT_URL¶

URL for the Django Logout action when using USE_SESSION_AUTH.

Default: django.conf.settings.LOGOUT_URL

SECURITY_DEFINITIONS¶

Swagger security definitions to be included in the specification.
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#security-definitions-object.

Default:

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

Swagger UI settings¶

Swagger UI configuration settings.
See https://github.com/swagger-api/swagger-ui/blob/112bca906553a937ac67adc2e500bdeed96d067b/docs/usage/configuration.md#parameters.

VALIDATOR_URL¶

URL pointing to a swagger-validator instance; used for the validation badge shown in swagger-ui. Can be modified to point to a local install of swagger-validator or set to None to remove the badge.

Default: ‘http://online.swagger.io/validator/’
Maps to parameter: validatorUrl

OPERATIONS_SORTER¶

Sorting order for the operation list of each tag.

None: show in the order returned by the server
alpha: sort alphabetically by path
method: sort by HTTP method

Default: None
Maps to parameter: operationsSorter

TAGS_SORTER¶

Sorting order for tagged operation groups.

None: Swagger UI default ordering
alpha: sort alphabetically

Default: None
Maps to parameter: tagsSorter

DOC_EXPANSION¶

Controls the default expansion setting for the operations and tags.

None: everything is collapsed
list: only tags are expanded
full: all operations are expanded

Default: ‘list’
Maps to parameter: docExpansion

DEEP_LINKING¶

Automatically update the fragment part of the URL with permalinks to the currently selected operation.

Default: False
Maps to parameter: deepLinking

SHOW_EXTENSIONS¶

Show vendor extension (x-..) fields.

Default: True
Maps to parameter: showExtensions

DEFAULT_MODEL_RENDERING¶

Controls whether operations show the model structure or the example value by default.

model: show the model fields by default
example: show the example value by default

Default: ‘model’
Maps to parameter: defaultModelRendering

DEFAULT_MODEL_DEPTH¶

Controls how many levels are expaned by default when showing nested models.

Default: 3
Maps to parameter: defaultModelExpandDepth

`REDOC_SETTINGS`¶

ReDoc UI settings¶

ReDoc UI configuration settings.
See https://github.com/Rebilly/ReDoc#redoc-tag-attributes.

LAZY_RENDERING¶

Default: True
Maps to attribute: lazy-rendering

HIDE_HOSTNAME¶

Default: False
Maps to attribute: hide-hostname

EXPAND_RESPONSES¶

Default: ‘all’
Maps to attribute: expand-responses

PATH_IN_MIDDLE¶

Default: False
Maps to attribute: path-in-middle-panel