Django REST framework
Last updated
Was this helpful?
Last updated
Was this helpful?
Django REST framework - это мощный и гибкий набор инструментов для создания Web API.
Некоторые причины, по которым вы можете захотеть использовать REST framework:
Web-интерфейс API - огромный выигрыш в удобстве использования для ваших разработчиков.
, включая пакеты для и .
, поддерживающая как , так и источники данных.
Настраивается все - просто используйте , если вам не нужны .
Обширная документация и .
Используется и пользуется доверием всемирно известных компаний, включая , , и .
REST framework требует следующего:
Django (4.2, 5.0)
Python (3.8, 3.9, 3.10, 3.11, 3.12)
Мы настоятельно рекомендуем и официально поддерживаем только последние выпуски патчей каждой версии Python и Django.
Следующие пакеты являются необязательными:
Установите с помощью pip
, включая все дополнительные пакеты, которые вы хотите...
...или клонируйте проект с github.
Добавьте 'rest_framework'
в настройку INSTALLED_APPS
.
Если вы планируете использовать Web-интерфейс API, вы, вероятно, также захотите добавить представления входа и выхода из системы REST framework. Добавьте следующее в ваш корневой файл urls.py
.
Обратите внимание, что путь URL может быть любым, какой вы захотите.
Давайте рассмотрим быстрый пример использования REST-фреймворка для создания простого API с поддержкой модели.
Мы создадим API с функцией чтения-записи для доступа к информации о пользователях нашего проекта.
Все глобальные настройки для API REST-фреймворка хранятся в одном конфигурационном словаре с именем REST_FRAMEWORK
. Начните с добавления следующих параметров в модуль settings.py
:
Не забудьте убедиться, что вы также добавили rest_framework
в INSTALLED_APPS
.
Теперь мы готовы к созданию нашего API. Вот корневой модуль нашего проекта urls.py
:
Руководство проведет вас через все этапы настройки DRF. Это займет не очень много времени, однако вы получите полное понимание того, как все компоненты работают друг с другом и данное руководство крайне рекомендовано к прочтению.
Навигатор по API - исчерпывающее руководство по всему функционалу, предоставляемому DRF.
Основные руководства для использующих DRF.
Пожалуйста, сообщайте о проблемах безопасности по электронной почте security@djangoproject.com.
После этого сопровождающие проекта будут работать с вами над решением любых вопросов, если потребуется, до обнародования информации.
Спасибо всем за помощь в переводе!
, (5.1+, 3.0.0+) - Поддержка генерации схем.
(3.3.0+) - Поддержка Markdown для Web-интерфейса API.
(2.7.0+) - Добавление подсветки синтаксиса в обработку Markdown.
(1.0.1+) - Поддержка фильтрации.
(1.1.1+) - Поддержка разрешений на уровне объектов.
Теперь вы можете открыть API в браузере по адресу и просмотреть новых "пользователей" API. Если вы используете элемент управления входом в систему в правом верхнем углу, вы также сможете добавлять, создавать и удалять пользователей из системы.
Не можете дождаться начала работы? Руководство - это самый быстрый способ начать работу и создавать API с помощью REST framework.
Так же есть пример работающего API законченного руководства для тестовых целей, .
Смотрите для получения информации о том, как клонировать репозиторий, запустить набор тестов и внести изменения в REST Framework.
За поддержкой обращайтесь в , попробуйте использовать канал #restframework
на irc.libera.chat
, или задайте вопрос на , обязательно указав тег .
Для получения приоритетной поддержки подпишитесь на .
Вопросы безопасности решаются под руководством .
Перевод производится с помощью утилиты