DRF - Быстрый старт

Django Rest framework.

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

# Создадим папку и переместимся в неё
mkdir tutorial && cd tutorial

# Создадим и активируем виртуальное окружение
virtualenv -p python3 venv
source ./venv/bin/activate

# Установим Django и Django REST framework
pip install django djangorestframework

# Создадим новые проект и простое приложение
django-admin startproject tutorial .  # Обратите внимание на символ '.'
cd tutorial
django-admin startapp quickstart
cd ..

Структура проекта должна выглядеть так:

./manage.py
./tutorial
./tutorial/__init__.py
./tutorial/quickstart
./tutorial/quickstart/__init__.py
./tutorial/quickstart/admin.py
./tutorial/quickstart/apps.py
./tutorial/quickstart/migrations
./tutorial/quickstart/migrations/__init__.py
./tutorial/quickstart/models.py
./tutorial/quickstart/tests.py
./tutorial/quickstart/views.py
./tutorial/settings.py
./tutorial/urls.py
./tutorial/wsgi.py

Может показаться странным то, что приложение было создано в каталоге проекта.

Использование пространства имен проекта позволяет избежать столкновений имен с внешними модулями (тема, которая выходит за рамки быстрого старта).

Теперь запустим миграцию для базы данных:

python manage.py migrate

Также создадим пользователя с именем admin с паролем password123.

Позже в нашем примере мы будем аутентифицироваться как этот пользователь.

python manage.py createsuperuser --username amdin

База данных настроена, пользователь создан. Откройте каталог приложения в IDE, начнём кодить.

Serializers

Создадим несколько сериализаторов.

Давайте сначала создадим новый модуль с именем tutorial/quickstart/serializers.py, который мы будем использовать для представления данных.

from django.contrib.auth.models import User, Group
from rest_framework import serializers


class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ['url', 'username', 'email', 'groups']


class GroupSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Group
        fields = ['url', 'name']

Обратите внимание, что в этом случае мы используем гиперссылки с HyperlinkedModelSerializer.

Вы также можете использовать primary key и другие отношения, но гиперссылка - хороший тон в RESTful.

Views

Теперь нам лучше написать несколько views.

Откройте tutorial/quickstart/views.py и пропишите:

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint, позволяющий просматривать и редактировать пользователей
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint, позволяющий просматривать и редактировать группы
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer

Вместо того, чтобы писать несколько views, мы группируем общее поведение в классы, называемые ViewSets.

Мы можем легко разбить их на отдельные views, если портебуется, но использование ViewSets позволяет хорошо организовать логику и сохранить лаконичность.

URLs

Теперь давайте подключим URL-адреса API.

Открываем tutorial/urls.py:

from django.urls import include, path
from rest_framework import routers
from tutorial.quickstart import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)

# Подключите наш API с помощью автоматической маршрутизации URL
# Кроме того, мы включили URL для входа в систему через браузер

urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

Поскольку вместо views мы используем ViewSets, мы можем автоматически генерировать URL-адрес для нашего API, просто регистрируя ViewSets классом Router.

Pagination

Пагинация позволяет вам контролировать, сколько объектов на странице возвращается.

Чтобы включить её, добавьте следующие строки в tutorial/settings.py:

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

Settings

Добавьте rest_framework в INSTALLED_APPS. Файл настроек находится в tutorial/settings.py:

INSTALLED_APPS = [
    ...
    'rest_framework',
]

Отлично. Мы всё сделали!

Проверка работоспособности API

Теперь мы готовы протестировать созданный нами API. Давайте запустим сервер из командной строки.

python manage.py runserver

Теперь мы можем получить доступ к нашему API из командной строки, используя curl

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": "admin@example.com",
            "groups": [],
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin"
        },
        {
            "email": "tom@example.com",
            "groups": [                ],
            "url": "http://127.0.0.1:8000/users/2/",
            "username": "tom"
        }
    ]
}

Или используя инструмент командной строки httpie

http -a admin:password123 http://127.0.0.1:8000/users/

HTTP/1.1 200 OK
...
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "email": "admin@example.com",
            "groups": [],
            "url": "http://localhost:8000/users/1/",
            "username": "paul"
        },
        {
            "email": "tom@example.com",
            "groups": [                ],
            "url": "http://127.0.0.1:8000/users/2/",
            "username": "tom"
        }
    ]
}

Или непосредственно через браузер, перейдя по URL-адресу http://127.0.0.1:8000/users/

Django Rest Fraemwork Quickstart

Если вы работаете через браузер, обязательно войдите в систему, используя кнопку в верхнем правом углу. (Log in)

Отлично, это было не сложно!