Django REST Swagger

Монтаж
$ pip install django-rest-swagger

Добавить 'rest_framework_swagger' к INSTALLED_APPS в настройках Django.

settings.py

INSTALLED_APPS = [
    ...
    'rest_framework_swagger',
    ...
]

Быстрый старт
Чтобы быстро начать работу, используйте get_swagger_view ярлык. Это создаст представление схемы, которое использует общие настройки. Для более расширенного использования, пожалуйста, смотрите раздел схемы.

пример
views.py

from django.conf.urls import url
from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='Pastebin API')

urlpatterns = [
    url(r'^$', schema_view)
]

Посмотреть в браузере

Пример приложения
Пример, основанный на Учебном руководстве по REST Django, поставляется вместе с проектом. Это и может быть опционально локально с помощью Docker, или развернуто бесплатно на героку.

Развертывание с Heroku

Учетные данные для входа:

username: amy
password: amy

Инструкции по докеру
Убедитесь, что Docker Docker установлен в вашей системе.

Сначала клонируем репозиторий:

$ git clone https://github.com/marcgibbons/django-rest-swagger

Чтобы быстро начать работу с использованием образа Docker, просто запустите:

$ ./run_example.sh

Начальный запуск может занять несколько минут. После завершения приложение будет доступно по адресу http://localhost:8000

Учетные данные для входа:

username: amy
password: amy

Изменения в 2.0
Версия 2.0 принципиально отличается от предыдущих версий и использует новые возможности генерации схем, представленные в Django REST Framework 3.4. Самоанализ выполняется платформой и использует CoreAPI для хранения определений. Это серьезное изменение по сравнению с предыдущими версиями, которые отвечали за самоанализ и переопределения.

Новое:

  • SwaggerUI и спецификация OpenAPI являются классами рендеринга (более простая конфигурация)
  • SwaggerUI 2.1.6
  • Улучшенная производительность
  • Разрешить несколько экземпляров Swagger UI в одном проекте Django
  • Разрешить независимую визуализацию спецификации OpenAPI JSON
  • Улучшено управление механизмами аутентификации

Запрещены:

  • YAML документы

Лицензия
Copyright (c) 2013-2016, Marc Gibbons
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Далее : Django REST Swagger : Визуализация схемы

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