Django REST Swagger настройки

Конфигурация Django REST Swagger идентична Django REST Framework. Настройки настраиваются settings.py путем определения SWAGGER_SETTINGS.

Пример:

settings.py

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

Аутентификация
USE_SESSION_AUTH
Переключает использование Django Auth в качестве механизма аутентификации. При установке этого параметра на True пользовательском интерфейсе Swagger будет отображаться кнопка входа / выхода и отправка csrf_tokens в API.

По умолчанию: True

Примечание. Кнопка входа в систему / выхода из системы основана на настройках LOGIN_URL и  LOGOUT_URL настройках по умолчанию /accounts/login. Их можно настроить в  SWAGGER_SETTINGS настройках Django или

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
URL-адрес, используемый для входа в систему аутентификации сеанса. Принимает именованные шаблоны URL.

По умолчанию: django.conf.settings.LOGIN_URL

LOGOUT_URL
URL-адрес, используемый для выхода из сеанса аутентификации. Принимает именованные шаблоны URL.

По умолчанию: django.conf.settings.LOGOUT_URL

SECURITY_DEFINITIONS
Определения безопасности определяют, какие методы аутентификации могут использоваться Swagger. Типы схем в настоящее время поддерживаются спецификации OpenAPI 2.0 являются  basic, apiKey и oauth2.

Для получения дополнительной информации о доступных опциях, пожалуйста, обратитесь к Определению объекта безопасности OpenAPI .

По умолчанию:

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

Настройки SwaggerUI
Ниже приведены основные настройки конфигурации для SwaggerUI. Обратите внимание, что для более сложных случаев вы можете написать свой собственный  rest_framework_swagger/static/init.js файл.

APIS_SORTER
Установите для alphaвключения сортировки по алфавиту.

По умолчанию: None

DOC_EXPANSION
Управляет отображением списка API. Может быть установлено:

  • None: Все операции свернуты
  • "list": Список всех операций
  • "full": Расширяет все операции

По умолчанию: None

JSON_EDITOR
Включает графическое представление для редактирования сложных тел.

По умолчанию: False

OPERATIONS_SORTER
Сортирует список операций каждого API. Может быть установлено:

  • alpha: Сортировать по алфавиту
  • method: Сортировка по методу HTTP

По умолчанию: None

SHOW_REQUEST_HEADERS
Установите для True отображения заголовков запроса.

По умолчанию: False

SUPPORTED_SUBMIT_METHODS
Список методов HTTP можно взаимодействовать с помощью «Попробуйте!» кнопка.

По умолчанию: ['get', 'post', 'put', 'delete', 'patch']

VALIDATOR_URL
URL-адрес валидатора схемы swagger.io. Может быть изменен для указания на локальную установку или None отключен.

По умолчанию: https://online.swagger.io/validator/

Далее : Django REST Swagger : Настройка пользовательского интерфейса

17 января 2019 г. 21:46 Теги - # Swagger # django rest framework # django Категория - Django rest framework Kiwi standing on oval394