Примеры¶

Обычно при использовании общих представлений вы переопределяете представление и устанавливаете несколько атрибутов класса.

from django.contrib.auth.models import User
from myapp.serializers import UserSerializer
from rest_framework import generics
from rest_framework.permissions import IsAdminUser

class UserList(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = [IsAdminUser]

Для более сложных случаев вы также можете захотеть переопределить различные методы класса представления. Например.

class UserList(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = [IsAdminUser]

    def list(self, request):
        # Note the use of `get_queryset()` instead of `self.queryset`
        queryset = self.get_queryset()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

Для очень простых случаев вы можете передать любые атрибуты класса с помощью метода .as_view(). Например, ваша URLconf может включать что-то вроде следующей записи:

path('users/', ListCreateAPIView.as_view(queryset=User.objects.all(), serializer_class=UserSerializer), name='user-list')

GenericAPIView¶

Этот класс расширяет класс APIView фреймворка REST, добавляя часто требуемое поведение для стандартных представлений списка и детализации.

Каждое из конкретных общих представлений создается путем объединения GenericAPIView , с одним или несколькими классами-миксинами.

def get_queryset(self):
    user = self.request.user
    return user.accounts.all()

def get_object(self):
    queryset = self.get_queryset()
    filter = {}
    for field in self.multiple_lookup_fields:
        filter[field] = self.kwargs[field]

    obj = get_object_or_404(queryset, **filter)
    self.check_object_permissions(self.request, obj)
    return obj

def filter_queryset(self, queryset):
    filter_backends = [CategoryFilter]

    if 'geo_route' in self.request.query_params:
        filter_backends = [GeoRouteFilter, CategoryFilter]
    elif 'geo_point' in self.request.query_params:
        filter_backends = [GeoPointFilter, CategoryFilter]

    for backend in list(filter_backends):
        queryset = backend().filter_queryset(self.request, queryset, view=self)

    return queryset

def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer

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

def perform_update(self, serializer):
    instance = serializer.save()
    send_email_confirmation(user=self.request.user, modified=instance)

def perform_create(self, serializer):
    queryset = SignupRequest.objects.filter(user=self.request.user)
    if queryset.exists():
        raise ValidationError('You have already signed up')
    serializer.save(user=self.request.user)

ListModelMixin¶

Предоставляет метод .list(request, *args, **kwargs), который реализует перечисление набора запросов.

Если набор запросов заполнен, возвращается ответ 200 OK, в теле которого находится сериализованное представление набора запросов. По желанию данные ответа могут быть постраничными.

CreateModelMixin¶

Предоставляет метод .create(request, *args, **kwargs), который реализует создание и сохранение нового экземпляра модели.

Если объект создан, то возвращается ответ 201 Created с сериализованным представлением объекта в качестве тела ответа. Если представление содержит ключ с именем url , то заголовок Location ответа будет заполнен этим значением.

Если данные запроса, предоставленные для создания объекта, оказались недействительными, будет возвращен ответ 400 Bad Request, в теле которого будет содержаться информация об ошибке.

RetrieveModelMixin¶

Предоставляет метод .retrieve(request, *args, **kwargs), который реализует возврат существующего экземпляра модели в ответ.

Если объект может быть получен, то возвращается ответ 200 OK, с сериализованным представлением объекта в качестве тела ответа. В противном случае возвращается 404 Not Found.

UpdateModelMixin¶

Предоставляет метод .update(request, *args, **kwargs), который реализует обновление и сохранение существующего экземпляра модели.

Также предусмотрен метод .partial_update(request, *args, **kwargs), который аналогичен методу update, за исключением того, что все поля для обновления будут необязательными. Это позволяет поддерживать HTTP PATCH запросы.

Если объект обновлен, возвращается ответ 200 OK с сериализованным представлением объекта в качестве тела ответа.

Если данные запроса, предоставленные для обновления объекта, оказались недействительными, будет возвращен ответ 400 Bad Request, в теле которого будет содержаться информация об ошибке.

DestroyModelMixin¶

Предоставляет метод .destroy(request, *args, **kwargs), который реализует удаление существующего экземпляра модели.

Если объект удален, возвращается ответ 204 No Content, в противном случае возвращается ответ 404 Not Found.

CreateAPIView¶

Используется только для создания конечных точек.

Предоставляет обработчик метода post.

Расширяется: GenericAPIView

ListAPIView¶

Используется для конечных точек только для чтения для представления коллекции экземпляров модели.

Предоставляет обработчик метода get.

Расширяется: GenericAPIView

RetrieveAPIView¶

Используется для конечных точек только для чтения для представления одного экземпляра модели.

Предоставляет обработчик метода get.

Расширяется: GenericAPIView

DestroyAPIView¶

Используется для только для удаления конечных точек для одного экземпляра модели.

Предоставляет обработчик метода delete.

Расширяется: GenericAPIView

UpdateAPIView¶

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

Предоставляет обработчики методов put и patch.

Расширяется: GenericAPIView

ListCreateAPIView¶

Используется для конечных точек чтения-записи для представления коллекции экземпляров модели.

Предоставляет обработчики методов get и post.

Расширяется: GenericAPIView

RetrieveUpdateAPIView¶

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

Предоставляет обработчики методов get , put и patch.

Расширяется: GenericAPIView

RetrieveDestroyAPIView¶

Используется для конечных точек чтения или удаления для представления одного экземпляра модели.

Предоставляет обработчики методов get и delete.

Расширяется: GenericAPIView

RetrieveUpdateDestroyAPIView¶

Используется для конечных точек чтение-запись-удаление для представления одного экземпляра модели.

Предоставляет обработчики методов get , put , patch и delete.

Расширяется: GenericAPIView

Создание пользовательских миксинов¶

Например, если вам нужно искать объекты на основе нескольких полей в URL conf, вы можете создать класс mixin, подобный следующему:

class MultipleFieldLookupMixin:
    """
    Apply this mixin to any view or viewset to get multiple field filtering
    based on a `lookup_fields` attribute, instead of the default single field filtering.
    """
    def get_object(self):
        queryset = self.get_queryset()             # Get the base queryset
        queryset = self.filter_queryset(queryset)  # Apply any filter backends
        filter = {}
        for field in self.lookup_fields:
            if self.kwargs[field]: # Ignore empty fields.
                filter[field] = self.kwargs[field]
        obj = get_object_or_404(queryset, **filter)  # Lookup the object
        self.check_object_permissions(self.request, obj)
        return obj

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

class RetrieveUserView(MultipleFieldLookupMixin, generics.RetrieveAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    lookup_fields = ['account', 'username']

Использование пользовательских миксинов - хороший вариант, если у вас есть пользовательское поведение, которое необходимо использовать.

Создание пользовательских базовых классов¶

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

class BaseRetrieveView(MultipleFieldLookupMixin,
                       generics.RetrieveAPIView):
    pass

class BaseRetrieveUpdateDestroyView(MultipleFieldLookupMixin,
                                    generics.RetrieveUpdateDestroyAPIView):
    pass

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

Django Rest Multiple Models¶

Django Rest Multiple Models предоставляет общее представление (и миксин) для отправки нескольких сериализованных моделей и/или наборов запросов через один запрос API.