Введение в Django REST Framework

Краткое описание Django REST Framework и шаги по разработке простого веб-API с его использованием.

Введение

Django REST Framework (далее именуемый DRF) — это сторонняя библиотека, которая позволяет разрабатывать веб-API (REST) с помощью веб-фреймворка Python Django.

Это позволяет вам разрабатывать веб-приложения, которые полностью используют знания и функции Django и Python. В реальных проектах мы используем Django для базовой функциональности веб-приложения и используем DRF для реализации функций, специфичных для REST API.

Характеристики ДРФ

Ключевые преимущества DRF заключаются в следующем:

Полный доступ к мощным функциям Django
Имеет все функции, необходимые для разработки REST API по умолчанию.
Тестовый клиент «Browsable API», который позволяет вам видеть результаты выполнения вашего API.
Богатая и обширная официальная документация и официальные руководства
Поддерживаются OpenAPI и Swagger, а документация по API может создаваться автоматически.

Самая сильная сторона DRF — это его способность в полной мере использовать широкий спектр функций Django.

Установить

# Install Django and Django REST Framework
pip install django
pip install djangorestframework

# Set up a new project
django-admin startproject .
django-admin startapp firstapp

Проекты следующие:

./manage.py
./__init__.py
./firstapp
./firstapp/__init__.py
./firstapp/admin.py
./firstapp/apps.py
./firstapp/migrations
./firstapp/migrations/__init__.py
./firstapp/models.py
./firstapp/tests.py
./firstapp/views.py
./asgi.py
./settings.py
./urls.py
./wsgi.py

Настраивать

Перепишите переменную INSTALLED_APPS в settings.py следующим образом:

Здесь база данных синхронизируется в первый раз.

py manage.py migrate

Кроме того, создайте пользователя с именем adminс паролем password.

python manage.py createsuperuser --email [email protected] --username admin

Сериализаторы

Создайте новый файл ./firstapp/serializers.py и напишите следующий код:

Взгляды

Напишите следующий код в файле ./firstapp/virews.py.

URL-адрес

Тестирование API

После того, как вы собрали свой API таким образом, запустите его в командной строке.

py manage.py runserver

Используйте команду curl, чтобы протестировать разработанный вами API.

bash: curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/
{
 "count": 2,
 "next": null,
 "previous": null,
 "results": [
   {
    "email": "[email protected]",
    "groups": [],
    "url": "http://127.0.0.1:8000/users/1/",
    "username": "admin"
   },
 ]

}

Теперь вы можете разработать простой API. Это было легко!

Краткое содержание

В этой статье мы представили краткое описание Django REST Framework и шаги по разработке простого веб-API с его использованием.

Мы надеемся, что благодаря этой статье вам будет интересно узнать больше о Django REST Framework.

Введение в Django REST Framework

Краткое описание Django REST Framework и шаги по разработке простого веб-API с его использованием.