Как создать REST API на Python с Django Rest Framework: Пошаговое руководство для начинающих?

06.11.2025
62364

4 мин
64

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

Эта статья – ваш пошаговый гид по созданию REST API на Python с использованием Django Rest Framework. Мы рассмотрим все этапы, начиная с основ DRF и заканчивая развертыванием готового API в продакшн.

Основы Django Rest Framework

Что такое Django Rest Framework и зачем он нужен?

Django Rest Framework (DRF) – это мощный и гибкий инструмент для создания RESTful API на основе Django. Он предоставляет множество возможностей, включая:

Сериализацию и десериализацию данных.
Различные типы аутентификации и авторизации.
Гибкую систему маршрутизации.
Поддержку различных форматов данных (JSON, XML и др.).
Инструменты для тестирования API.

DRF значительно упрощает разработку API, позволяя разработчикам сосредоточиться на бизнес-логике, а не на технических деталях.

Установка и настройка DRF

Для начала работы с DRF необходимо установить его в ваше Django-окружение. Используйте pip:

pip install djangorestframework

После установки добавьте 'rest_framework' в список INSTALLED_APPS в файле settings.py вашего Django-проекта:

INSTALLED_APPS = [
    ...
    'rest_framework',
]

Также рекомендуется настроить глобальные параметры DRF в том же файле settings.py. Например, можно установить политику аутентификации по умолчанию:

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ],
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.TokenAuthentication',
    ]
}

Создание вашего первого API

Определение моделей Django и настройка базы данных

Первым шагом является определение моделей данных, которые будут использоваться в вашем API. Например, создадим модель Product в файле models.py:

from django.db import models

class Product(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField()
    price = models.DecimalField(max_digits=10, decimal_places=2)

    def __str__(self):
        return self.name

После определения моделей необходимо выполнить миграции базы данных:

python manage.py makemigrations
python manage.py migrate

Создание сериализаторов для представления данных

Сериализаторы в DRF используются для преобразования объектов Django в форматы данных, такие как JSON, и обратно. Создайте файл serializers.py в вашем приложении и определите сериализатор для модели Product:

from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product
        fields = '__all__'

Обработка запросов и маршрутизация

Настройка URL-маршрутов для API

Необходимо определить URL-маршруты для вашего API. Создайте файл urls.py в вашем приложении и настройте маршруты, используя routers из DRF:

from rest_framework import routers
from .views import ProductViewSet
from django.urls import path, include

router = routers.DefaultRouter()
router.register(r'products', ProductViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

Не забудьте включить urls.py вашего приложения в основной urls.py вашего проекта.

Реализация представлений (Views) для CRUD операций

Представления (Views) в DRF обрабатывают HTTP-запросы и возвращают ответы. Для реализации CRUD (Create, Read, Update, Delete) операций можно использовать ModelViewSet:

from rest_framework import viewsets
from .models import Product
from .serializers import ProductSerializer

class ProductViewSet(viewsets.ModelViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer

Безопасность и аутентификация

Аутентификация пользователей в API

DRF предоставляет различные механизмы аутентификации, включая:

Token Authentication.
Session Authentication.
JWT (JSON Web Token) Authentication.
OAuth.

Для использования Token Authentication необходимо добавить 'rest_framework.authentication.TokenAuthentication' в DEFAULT_AUTHENTICATION_CLASSES в settings.py и создать токены для пользователей. JWT Authentication является более современным и гибким подходом. Используйте библиотеки, такие как djangorestframework-simplejwt.

Настройка авторизации и разрешений

DRF также предоставляет систему разрешений, позволяющую контролировать доступ к API. Основные классы разрешений:

AllowAny – разрешает доступ всем.
IsAuthenticated – разрешает доступ только аутентифицированным пользователям.
IsAdminUser – разрешает доступ только администраторам.
ReadOnly – разрешает только чтение.

Можно создавать свои собственные классы разрешений, наследуясь от BasePermission.

Тестирование и развертывание

Написание тестов для вашего API

Тестирование API является важной частью процесса разработки. DRF предоставляет инструменты для написания тестов, такие как APIClient:

from rest_framework.test import APIClient
from django.urls import reverse
from rest_framework import status
from django.test import TestCase
from .models import Product

class ProductTests(TestCase):
    def setUp(self):
        self.client = APIClient()
        self.product_data = {'name': 'Test Product', 'description': 'Test Description', 'price': 10.00}
        self.product = Product.objects.create(**self.product_data)

    def test_can_create_product(self):
        response = self.client.post(reverse('product-list'), self.product_data, format='json')
        self.assertEqual(response.status_code, status.HTTP_201_CREATED)

Развертывание REST API на Django в продакшн

Для развертывания REST API на Django в продакшн необходимо:

Настроить веб-сервер (например, Nginx или Apache).
Использовать WSGI-сервер (например, Gunicorn или uWSGI).
Настроить базу данных.
Настроить статические файлы.
Использовать систему управления версиями (например, Git).

Рекомендуется использовать Docker для контейнеризации приложения.

Заключение

Создание REST API на Python с использованием Django Rest Framework – это мощный и эффективный способ разработки веб-сервисов. DRF предоставляет все необходимые инструменты для быстрой и безопасной разработки API. Следуя этому пошаговому руководству, вы сможете создать свой первый REST API и начать использовать его в своих проектах.