Разработка REST API на Django: пошаговая инструкция с примерами

python -m venv venv
source venv/bin/activate # для Linux/Mac
venv\Scripts\activate # для Windows

pip install django

django-admin startproject api_project
cd api_project

python manage.py startapp api

INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'api', # Наше новое приложение
]

python manage.py migrate

python manage.py createsuperuser

python manage.py runserver

pip install djangorestframework

INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'api',
'rest_framework', # Добавляем Django REST framework
]

REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10,
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.BasicAuthentication',
],
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.IsAuthenticated',
],
}

# api/urls.py
from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns

urlpatterns = [
# Здесь будут URL-маршруты для нашего API
]

urlpatterns = format_suffix_patterns(urlpatterns)

# api_project/urls.py
from django.contrib import admin
from django.urls import path, include

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

INSTALLED_APPS = [
# ...предыдущие приложения
'rest_framework.authtoken', # Добавляем поддержку токенов
]

REST_FRAMEWORK = {
# ...предыдущие настройки
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.TokenAuthentication',
'rest_framework.authentication.SessionAuthentication',
],
}

python manage.py migrate

# api/models.py
from django.db import models
from django.contrib.auth.models import User

class Task(models.Model):
STATUS_CHOICES = (
('pending', 'Pending'),
('in_progress', 'In Progress'),
('completed', 'Completed'),
('cancelled', 'Cancelled'),
)

title = models.CharField(max_length=200)
description = models.TextField(blank=True)
status = models.CharField(
max_length=20, 
choices=STATUS_CHOICES,
default='pending'
)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
owner = models.ForeignKey(
User, 
related_name='tasks',
on_delete=models.CASCADE
)

def __str__(self):
return self.title

class Meta:
ordering = ['-created_at']

python manage.py makemigrations
python manage.py migrate

# api/serializers.py
from rest_framework import serializers
from django.contrib.auth.models import User
from .models import Task

class TaskSerializer(serializers.ModelSerializer):
owner = serializers.ReadOnlyField(source='owner.username')

class Meta:
model = Task
fields = ['id', 'title', 'description', 'status', 
'created_at', 'updated_at', 'owner']

class UserSerializer(serializers.ModelSerializer):
tasks = serializers.PrimaryKeyRelatedField(
many=True, 
queryset=Task.objects.all()
)

class Meta:
model = User
fields = ['id', 'username', 'email', 'tasks']

# Добавьте в TaskSerializer для валидации поля title
def validate_title(self, value):
if len(value) < 5:
raise serializers.ValidationError("Title must be at least 5 characters long.")
return value

# Для валидации нескольких полей одновременно
def validate(self, data):
if data['status'] == 'completed' and not data.get('description'):
raise serializers.ValidationError("Completed tasks must have a description.")
return data

class TaskSerializer(serializers.ModelSerializer):
owner = UserSerializer(read_only=True)

class Meta:
model = Task
fields = ['id', 'title', 'description', 'status', 
'created_at', 'updated_at', 'owner']

class UserSummarySerializer(serializers.ModelSerializer):
class Meta:
model = User
fields = ['id', 'username', 'email']

class TaskSerializer(serializers.ModelSerializer):
owner = UserSummarySerializer(read_only=True)

class Meta:
model = Task
fields = ['id', 'title', 'description', 'status', 
'created_at', 'updated_at', 'owner']

# api/views.py
from rest_framework import generics, permissions
from django.contrib.auth.models import User
from .models import Task
from .serializers import TaskSerializer, UserSerializer
from .permissions import IsOwnerOrReadOnly

class TaskList(generics.ListCreateAPIView):
queryset = Task.objects.all()
serializer_class = TaskSerializer
permission_classes = [permissions.IsAuthenticated]

def perform_create(self, serializer):
serializer.save(owner=self.request.user)

class TaskDetail(generics.RetrieveUpdateDestroyAPIView):
queryset = Task.objects.all()
serializer_class = TaskSerializer
permission_classes = [permissions.IsAuthenticated, IsOwnerOrReadOnly]

class UserList(generics.ListAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer

class UserDetail(generics.RetrieveAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer

# api/permissions.py
from rest_framework import permissions

class IsOwnerOrReadOnly(permissions.BasePermission):
"""
Пользовательское разрешение, позволяющее только владельцам объекта редактировать его.
"""

def has_object_permission(self, request, view, obj):
# Разрешения на чтение разрешены для любых запросов
if request.method in permissions.SAFE_METHODS:
return True

# Права на запись разрешены только владельцу объекта
return obj.owner == request.user

# api/urls.py
from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from . import views

urlpatterns = [
path('tasks/', views.TaskList.as_view(), name='task-list'),
path('tasks/<int:pk>/', views.TaskDetail.as_view(), name='task-detail'),
path('users/', views.UserList.as_view(), name='user-list'),
path('users/<int:pk>/', views.UserDetail.as_view(), name='user-detail'),
]

urlpatterns = format_suffix_patterns(urlpatterns)

# api/views.py (альтернативная версия с ViewSets)
from rest_framework import viewsets, permissions
from django.contrib.auth.models import User
from .models import Task
from .serializers import TaskSerializer, UserSerializer
from .permissions import IsOwnerOrReadOnly

class TaskViewSet(viewsets.ModelViewSet):
"""
Этот набор представлений автоматически предоставляет `list`, `create`, `retrieve`,
`update` и `destroy` действия.
"""
queryset = Task.objects.all()
serializer_class = TaskSerializer
permission_classes = [permissions.IsAuthenticated, IsOwnerOrReadOnly]

def perform_create(self, serializer):
serializer.save(owner=self.request.user)

class UserViewSet(viewsets.ReadOnlyModelViewSet):
"""
Этот набор представлений автоматически предоставляет действия только для чтения.
"""
queryset = User.objects.all()
serializer_class = UserSerializer

# api/urls.py (альтернативная версия с маршрутизаторами)
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from . import views

# Создаем маршрутизатор и регистрируем наши наборы представлений
router = DefaultRouter()
router.register(r'tasks', views.TaskViewSet)
router.register(r'users', views.UserViewSet)

# API URLs настраиваются автоматически маршрутизатором
urlpatterns = [
path('', include(router.urls)),
]

pip install django-filter

# В settings.py
INSTALLED_APPS = [
# ...
'django_filters',
]

REST_FRAMEWORK = {
# ...
'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend'],
}

# api/views.py
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework import viewsets, permissions, filters

class TaskViewSet(viewsets.ModelViewSet):
queryset = Task.objects.all()
serializer_class = TaskSerializer
permission_classes = [permissions.IsAuthenticated, IsOwnerOrReadOnly]
filter_backends = [DjangoFilterBackend, filters.SearchFilter, filters.OrderingFilter]
filterset_fields = ['status']
search_fields = ['title', 'description']
ordering_fields = ['created_at', 'status']

def perform_create(self, serializer):
serializer.save(owner=self.request.user)

# api/tests.py
from django.urls import reverse
from django.contrib.auth.models import User
from rest_framework import status
from rest_framework.test import APITestCase
from .models import Task

class TaskTests(APITestCase):
def setUp(self):
# Создаем пользователя для тестов
self.test_user = User.objects.create_user('testuser', 'test@example.com', 'testpassword')

# Аутентифицируем клиент
self.client.force_authenticate(user=self.test_user)

# Создаем тестовую задачу
self.task = Task.objects.create(
title='Test Task',
description='Test Description',
status='pending',
owner=self.test_user
)

# URL для списка задач
self.list_url = reverse('task-list')

# URL для деталей задачи
self.detail_url = reverse('task-detail', args=[self.task.id])

def test_list_tasks(self):
"""
Проверяем, что можем получить список задач.
"""
response = self.client.get(self.list_url)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(len(response.data), 1)

def test_create_task(self):
"""
Проверяем, что можем создать новую задачу.
"""
data = {
'title': 'New Test Task',
'description': 'New Test Description',
'status': 'in_progress'
}
response = self.client.post(self.list_url, data, format='json')
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
self.assertEqual(Task.objects.count(), 2)

def test_retrieve_task(self):
"""
Проверяем, что можем получить существующую задачу.
"""
response = self.client.get(self.detail_url)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data['title'], 'Test Task')

def test_update_task(self):
"""
Проверяем, что можем обновить существующую задачу.
"""
data = {
'title': 'Updated Test Task',
'description': 'Updated Test Description',
'status': 'completed'
}
response = self.client.put(self.detail_url, data, format='json')
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data['title'], 'Updated Test Task')
self.assertEqual(response.data['status'], 'completed')

def test_delete_task(self):
"""
Проверяем, что можем удалить существующую задачу.
"""
response = self.client.delete(self.detail_url)
self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
self.assertEqual(Task.objects.count(), 0)

python manage.py test

pip install drf-yasg

# В settings.py добавьте в INSTALLED_APPS
INSTALLED_APPS = [
# ...
'drf_yasg',
]

# В api_project/urls.py добавьте
from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi

schema_view = get_schema_view(
openapi.Info(
title="Tasks API",
default_version='v1',
description="API for managing tasks",
terms_of_service="https://www.google.com/policies/terms/",
contact=openapi.Contact(email="contact@tasks.local"),
license=openapi.License(name="BSD License"),
),
public=True,
permission_classes=[permissions.AllowAny],
)

urlpatterns = [
# ...предыдущие URL-маршруты
path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
]

# В api/views.py
class TaskViewSet(viewsets.ModelViewSet):
"""
API endpoint для работы с задачами.

list:
Возвращает список всех задач.

create:
Создает новую задачу.

retrieve:
Возвращает детали задачи по ID.

update:
Обновляет задачу полностью.

partial_update:
Обновляет задачу частично.

destroy:
Удаляет задачу.
"""
# ... остальной код

# Установка httpie
pip install httpie

# Получение токена аутентификации
http POST http://localhost:8000/api-token-auth/ username=testuser password=testpassword

# Использование токена для создания задачи
http POST http://localhost:8000/api/tasks/ title="New Task" description="Task Description" "Authorization: Token YOUR_TOKEN_HERE"

# Получение списка задач
http GET http://localhost:8000/api/tasks/ "Authorization: Token YOUR_TOKEN_HERE"

pip install django-cors-headers

# В settings.py
INSTALLED_APPS = [
# ...
'corsheaders',
]

MIDDLEWARE = [
'corsheaders.middleware.CorsMiddleware',
# ... остальные middleware
]

# Разрешить все домены (только для разработки!)
CORS_ALLOW_ALL_ORIGINS = True

# Или указать конкретные домены
CORS_ALLOWED_ORIGINS = [
"https://example.com",
"https://sub.example.com",
]