Быстрый старт

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

Настройка проекта

Создайте новый проект Django под названием tutorial, затем создайте новое приложение под названием quickstart.

# Create the project directory
mkdir tutorial
cd tutorial

# Create a virtual environment to isolate our package dependencies locally
python3 -m venv env
source env/bin/activate  # On Windows use `env\Scripts\activate`

# Install Django and Django REST framework into the virtual environment
pip install djangorestframework

# Set up a new project with a single application
django-admin startproject tutorial .  # Note the trailing '.' character
cd tutorial
django-admin startapp quickstart
cd ..

Схема проекта должна выглядеть следующим образом:

$ pwd
<some path>/tutorial
$ find .
.
./tutorial
./tutorial/asgi.py
./tutorial/__init__.py
./tutorial/quickstart
./tutorial/quickstart/migrations
./tutorial/quickstart/migrations/__init__.py
./tutorial/quickstart/models.py
./tutorial/quickstart/__init__.py
./tutorial/quickstart/apps.py
./tutorial/quickstart/admin.py
./tutorial/quickstart/tests.py
./tutorial/quickstart/views.py
./tutorial/settings.py
./tutorial/urls.py
./tutorial/wsgi.py
./env
./env/...
./manage.py

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

Теперь синхронизируйте базу данных в первый раз:

python manage.py migrate

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

python manage.py createsuperuser --username admin --email [e-mail]

После того как вы настроили базу данных и создали начального пользователя, откройте каталог приложения и приступайте к работе...

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

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

from django.contrib.auth.models import Group, User
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. Вы также можете использовать первичный ключ и различные другие отношения, но гиперсвязь - это хороший дизайн RESTful.

Представления

Итак, нам нужно написать несколько представлений. Откройте tutorial/quickstart/views.py и начните печатать.

from django.contrib.auth.models import Group, User
from rest_framework import permissions, viewsets

from tutorial.quickstart.serializers import GroupSerializer, UserSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer
    permission_classes = [permissions.IsAuthenticated]


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows groups to be viewed or edited.
    """
    queryset = Group.objects.all().order_by('name')
    serializer_class = GroupSerializer
    permission_classes = [permissions.IsAuthenticated]

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

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

URL-адреса

Итак, теперь давайте подключим 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)

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

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

Опять же, если нам нужен больший контроль над URL API, мы можем просто вернуться к использованию обычных представлений на основе классов и явного написания URL conf.

Наконец, мы включаем стандартные представления входа и выхода для использования с Web-интерфейсом API. Это необязательно, но полезно, если ваш API требует аутентификации, а вы хотите использовать Web-интерфейс API.

Пагинация

Пагинация позволяет управлять количеством возвращаемых объектов на странице. Чтобы включить эту функцию, добавьте следующие строки в tutorial/settings.py

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

Настройки

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

INSTALLED_APPS = [
    ...
    'rest_framework',
]

Хорошо, мы закончили.

---

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

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

python manage.py runserver

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

bash: curl -u admin -H 'Accept: application/json; indent=4' http://127.0.0.1:8000/users/
Enter host password for user 'admin':
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin",
            "email": "[e-mail]",
            "groups": []
        }
    ]
}

Или с помощью httpie, инструмента командной строки...

bash: http -a admin http://127.0.0.1:8000/users/
http: password for admin@127.0.0.1:8000::
$HTTP/1.1 200 OK
...
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "email": "[e-mail]",
            "groups": [],
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin"
        }
    ]
}

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

Изображение быстрого запуска

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

Отлично, это было легко!

Если вы хотите получить более глубокое понимание того, как устроен DRF, перейдите к учебнику или начните просматривать руководство по API.