Django REST Framework: создание API

1pip install djangorestframework

1# settings.py
2INSTALLED_APPS = [
3    'rest_framework',
4    'myapp',
5]
6
7REST_FRAMEWORK = {
8    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
9    'PAGE_SIZE': 20,
10    'DEFAULT_AUTHENTICATION_CLASSES': [
11        'rest_framework.authentication.TokenAuthentication',
12    ],
13}

1# serializers.py
2from rest_framework import serializers
3from .models import User
4
5class UserSerializer(serializers.ModelSerializer):
6    class Meta:
7        model = User
8        fields = ['id', 'name', 'email', 'created_at']
9        read_only_fields = ['id', 'created_at']
10
11    def validate_email(self, value):
12        if User.objects.filter(email=value).exists():
13            raise serializers.ValidationError("Email already exists")
14        return value

1class ProductSerializer(serializers.ModelSerializer):
2    category_name = serializers.CharField(source='category.name', read_only=True)
3
4    class Meta:
5        model = Product
6        fields = ['id', 'name', 'price', 'category', 'category_name']
7
8class OrderSerializer(serializers.ModelSerializer):
9    products = ProductSerializer(many=True, read_only=True)
10    total_price = serializers.SerializerMethodField()
11
12    class Meta:
13        model = Order
14        fields = ['id', 'products', 'total_price', 'created_at']
15
16    def get_total_price(self, obj):
17        return sum(p.price for p in obj.products.all())

1# views.py
2from rest_framework import viewsets, status
3from rest_framework.decorators import action
4from rest_framework.response import Response
5from .models import User
6from .serializers import UserSerializer
7
8class UserViewSet(viewsets.ModelViewSet):
9    queryset = User.objects.all()
10    serializer_class = UserSerializer
11
12    @action(detail=False, methods=['get'])
13    def me(self, request):
14        serializer = self.get_serializer(request.user)
15        return Response(serializer.data)
16
17    @action(detail=True, methods=['post'])
18    def activate(self, request, pk=None):
19        user = self.get_object()
20        user.is_active = True
21        user.save()
22        return Response({'status': 'activated'})

1# urls.py
2from django.urls import path, include
3from rest_framework.routers import DefaultRouter
4from .views import UserViewSet
5
6router = DefaultRouter()
7router.register(r'users', UserViewSet)
8
9urlpatterns = [
10    path('api/', include(router.urls)),
11]

1# views.py
2from rest_framework.authtoken.views import ObtainAuthToken
3from rest_framework.authtoken.models import Token
4
5class CustomAuthToken(ObtainAuthToken):
6    def post(self, request, *args, **kwargs):
7        serializer = self.serializer_class(data=request.data,
8                                           context={'request': request})
9        serializer.is_valid(raise_exception=True)
10        user = serializer.validated_data['user']
11        token, created = Token.objects.get_or_create(user=user)
12        return Response({
13            'token': token.key,
14            'user_id': user.pk,
15            'email': user.email
16        })

1# settings.py
2REST_FRAMEWORK = {
3    'DEFAULT_AUTHENTICATION_CLASSES': (
4        'rest_framework_simplejwt.authentication.JWTAuthentication',
5    ),
6}
7
8# urls.py
9from rest_framework_simplejwt.views import (
10    TokenObtainPairView,
11    TokenRefreshView,
12)
13
14urlpatterns = [
15    path('api/token/', TokenObtainPairView.as_view()),
16    path('api/token/refresh/', TokenRefreshView.as_view()),
17]

1from rest_framework import permissions
2
3class IsOwnerOrReadOnly(permissions.BasePermission):
4    def has_object_permission(self, request, view, obj):
5        if request.method in permissions.SAFE_METHODS:
6            return True
7        return obj.owner == request.user
8
9class IsAdminOrReadOnly(permissions.BasePermission):
10    def has_permission(self, request, view):
11        if request.method in permissions.SAFE_METHODS:
12            return True
13        return request.user and request.user.is_staff
14
15# Использование
16class ArticleViewSet(viewsets.ModelViewSet):
17    queryset = Article.objects.all()
18    serializer_class = ArticleSerializer
19    permission_classes = [IsAdminOrReadOnly]

1from rest_framework.pagination import PageNumberPagination, LimitOffsetPagination
2
3class StandardResultsSetPagination(PageNumberPagination):
4    page_size = 20
5    page_size_query_param = 'page_size'
6    max_page_size = 100
7
8# Использование
9class ArticleViewSet(viewsets.ModelViewSet):
10    pagination_class = StandardResultsSetPagination

1from django_filters.rest_framework import DjangoFilterBackend
2from rest_framework.filters import SearchFilter, OrderingFilter
3
4class ArticleViewSet(viewsets.ModelViewSet):
5    filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter]
6    filterset_fields = ['category', 'author']
7    search_fields = ['title', 'content']
8    ordering_fields = ['created_at', 'title']

1from rest_framework.test import APITestCase
2from rest_framework import status
3
4class UserAPITest(APITestCase):
5    def setUp(self):
6        self.user = User.objects.create_user(
7            email='test@test.com',
8            password='testpass123'
9        )
10        self.client.force_authenticate(user=self.user)
11
12    def test_get_users(self):
13        response = self.client.get('/api/users/')
14        self.assertEqual(response.status_code, status.HTTP_200_OK)
15
16    def test_create_user(self):
17        data = {'name': 'John', 'email': 'john@test.com'}
18        response = self.client.post('/api/users/', data)
19        self.assertEqual(response.status_code, status.HTTP_201_CREATED)