Django-rest-framework教程

基于类的视图的一个关键好处是，它允许组合一些可重用的行为。REST framework利用这一点，通过提供许多预构建的视图来提供常用视图。
REST framework提供的通用视图允许你快速构建紧密映射到数据库模型的API视图。
如果通过视图不适合你的API需求，也可以直接使用常规APIView类，或者重用通用视图使用的mixins和基类来组成自己的可重用通用视图集。

示例

通常，在使用通用视图时，将重写视图，并设置几个类属性。

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


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

对于更复杂的情况，可能还想重写视图类中的各种方法，例如：

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


    def list(self, request):
        queryset = self.get_queryset()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

对于非常简单的情况，可能想使用.as_view()方法传递任何类属性。例如，URLconf可能包含类似于以下条目的内容：

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

API参考

GenericAPIView

此类扩展了REST框架的APIView类，为标准列表和详细信息视图添加了常用的行为。
提供的每个具体通用视图是通估计GenericAPIView与一个或多个mixin类组而构建的。

属性

基本设置：

queryset：用于从此视图返回对象的查询集。通常，必须是设置此属性，或覆盖该get_queryset()方法。如果你正在重写视图方法，那么重要的是调用get_queyset()，而不是直接访问此属性，因为queryset将被评估一次，并且将这些结果被缓存用于所有后续请求。
serializer_class：用于验证和反序列化输入以及序列化输出的序列化类。通常，必须设置此属性，或重写get_serializer_class()方法。
lookup_field：用于执行各个模型示例的对象查找的模型字段。默认为pk。注意：在使用超连接API时，如果需要使用自定义值，则需要确保API视图和序列化器类都设置查找字段。
lookup_url_kwarg：用于对象查找的URL关键字参数。URLconf应该包含与此值相对应的关键字参数。如果取消设置默认值，使用lookup_field相同的值。

分页：
与列表视图一起使用时，以下属性用于控制分页：

pagination_class：分页列表结果时应使用的分页类。默认为与DEFAULT_PAGINATION_CLASS设置相同的值，即rest_framework.pagination.PageNumberPagination。设置pagination_class = None将禁用此页面上的分页。

过滤：

filter_backends：用于过滤查询集的过滤器后端列表。默认值与DEFAULT_FILTER_BACKENDS设置相同。

方法

基本方法：

get_queryset()
返回应该用于列表视图的查询集，该查询集应该用作详细视图中查找的基础。默认返回queryset属性指定的查询集。
应始终使用此方法而不是self.queryset直接访问，因为self.queryset值进行一次评估，并未所有后续请求缓存这些结果。
可以重写以提供动态行为，例如返回查询集，该查询集特定于发出请求的用户。
示例：
```
def get_queryset(self):
  user = self.request.user
  return user.accounts.all()
```
get_object(self)
返回应该用于详细视图的对象实例。默认使用lookup_field参数来过滤基本查询集。
可以重写以提供更复杂的行为，例如基于多个URL kwarg的对象查找。
```
def get_object(self):
  queryset = self.get_queryset()
  filter = {}
  for field in self.mutiple_lookup_fields:
      filter[field] = self.kwargs[field]
  obj = get_object_or_404(queryset, **filter)
  self.check_object_permission(self.request, obj)
  return obj
```
注意，如果API不包含任何对象级权限，可以选择性地排除self.check_object_permissions，并简单从get_object_or_404查找中返回该对象。

filter_queryset(self, queryset)
给定一个查询集，使用正在使用的任何过滤后端过滤它，返回一个新的查询集。

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

  if "geo_rote" in self.request.query_params:
      filter_backends = [GeoRouteFilter, CategoryFilter]
  elif "geo_point" in self.request.query_params:
      filter_backends = [GenRouteFilter, CategoryFilter]

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

get_serializer_class(self)
返回应用于序列化程序的类，默认返回serializer_class属性。
可以重写提供动态行为，例如使用不同序列化程序进行读写操作，或者为不同类型的用户提供不同的序列化程序。
```
def get_serializer_class(self):
  if self.request.user.is_staff:
      return FullAccountSerializer
  return BasicAccountSerializer
```

保存和删除钩子：
mixin类提供了以下方法，可以轻松的重写对象的保存和删除行为：

perform_create(self, serializer)：在保存新对象实例时由CreateModelMixin调用。
perform_update(self, serializer)：在保存现有对象实例时由UpdateModelMixin调用。
perform_destroy(self, instance)：在删除对象实例时由DestroyModelMixin调用。
这些钩子特别适用于设置请求中隐含的属性，但不是请求数据的一部分。例如，可以基于请求用户或基于URL关键字参数对在对象上设置属性。
```
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)
```
您还可以使用这些钩子通过引发ValidationError()来提供额外的验证。如果您需要在数据库保存时应用一些验证逻辑，这将非常有用。例如：
```
def perform_create(self, serializer):
  queryset = SingupRequest.objects.filter(user=self.request.user)
  if queryset.exists():
      raise ValidationError("You have already signed up")
  serializer.save(user=self.request.user)
```

其他方法：
通常不需要重写一下方法，但如果使用GenericAPIView编写自定义视图，则可能需要调用它们。

get_serializer_context(self)：返回包含应该被提供给序列化器的任何附加上下文的字典。默认包括request, view和format键。
get_serializer(self, instance=None, data=None, many=False, partial=False)：返回一个序列化器实例。
get_paginated_response(self, data)：返回分页样式的Response对象。
paginate_queryset(self, queryset)：根据需要为查询集分页，或者返回一个页面对象；如果没有该视图配置分页，则为None。
filter_queryset(self, queryset)：给定一个查询集，使用任何后端过滤器进行过滤，返回一个新的查询集。

Mixins

mixin类用于提供基本视图行为的操作。注意，mixin类提供了操作方法，而不是直接定义处理方法，如.get()和.post()。这允许更灵活的行为组合。

ListModelMixin

提供.list(request, *args, **kwargs)方法，它实现列出查询集。
如果天秤了查询集，则返回200 OK相应，并将查询集的序列化表示作为相应的主体，相应数据可以选择分页。

CreateModelMixin

提供.create(request, *args **kwargs)方法，用于实现创建和保存新模型实例。
如果对象被创建，则返回201 Created响应，并将该对象的序列化表示形式作为响应的主题。如果该表示包含名为url的键，则相应的Location头将填充该值。

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, CreateModelMixin

ListAPIView

用只读端点表示模型实例的集合。
提供GET方法处理程序。
扩展：GenericAPIView, ListModelMixin

RetrieveAPIView

用只读端点表示单个模型实例。
提供GET方法处理程序。
扩展：GenericAPIView, RetrieveModelMixin

DestroyAPIView

用于仅删除单个模型实例的端点。
提供DELETE方法处理程序。
扩展：GenericAPIView, DestroyModelMixin

UpdateAPIView

用于只更新单个模型实例的端点。
提供PUT和PATCH方法处理程序。
扩展：GenericAPIView, UpdateModelMixin

ListCreateAPIView

用读写端点来表示模型示例的集合。
提供GET和POST方法处理程序。
扩展：GenericAPIView, ListModelMixin, CreateModelMixin

RetrieveUpdateAPIView

用于读取或更新端点以表示单个模型实例。
提供GET, PUT和PATCH方法处理程序。
扩展：GenericAPIView, RetrieveModelMixin, DestroyModelMixin

RetrieveUpdateDestroyAPIView

用于读取或更新端点以表示单个模型实例。
提供GET, PUT, PATCH和DELETE方法处理程序。
扩展：GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin

自定义通用视图

通常你希望使用现有的通用视图，但要使用一些稍微定制的行为，如果你发现自己在多个位置重复使用某些自定义行为，则可能需要将该行为重构为公共类，然后可以根据需要将其应用于任何视图或视图集。

创建自定义mixins

例如，如果需要根据URLconf中的多个字段查找对象，则可以创建如下所以的mixin类。

class MutipleFieldLookupMixin(object):
    """
    将此mixin应用于任何视图或视图集，以基于lookup_fields属性获得多个字段过滤，而不是默认的单字段过滤
    """
    def get_object(self):
    queryset = self.get_queryset()
    queryset = self.filter_queryset(queryset)
    filter = {}
    for field in self.lookup_fields:
        if self.kwargs[field]:
            filter[field] = self.kwargs[field]
    obj = get_object_or_404(queryset, **filter)
    self.check_object_permissions(self.request, obj)
    return obj

然后可以在需要应用自定义行为的任何时候，将该mixin应用于视图或视图集。

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

创建自定义基类

若果多歌视图中使用mixin，则可以进一步，创建自己的一组基本视图，然后可以在整个项目中使用。

class BaseRetrieveView(MultipleFieldLookupMixin, generic.RetrieveAPIView):
    pass

class BaseRetrieveUpdateDestroyView(MultipleFieldLookupMixin, generic.RetrieveUpdateDestroyAPIView):
    pass

PUT as create

在drf框架3.0版本之前，REST framework mixins将PUT视为更新或创建操作，这取决于对象是否已经存在。
允许PUT作为创建操作是有问题的，因为它必然暴露有关对象存在或不存在的信息。同样不明显的是，透明地允许重新创建以前删除的实例，这必然是比简单地返回404响应更好的默认行为。
PUT as 404和 PUT as create在不同情况下都可以有效，但从版本3.0开始，我们现在使用404行为作为默认值，因为它更简单，更明显。
如果需要通用的PUT as create行为，可能希望将类似AllowPUTAsCreateMixin的类作为mixin包含在视图中。

第三方包

Django REST Framework bulk

实现了通用的视图混合，以及一些通用的具体视图，允许通过API请求应用批量操作。

Django Rest Multiple Models

提供了要一个通用视图和mixin，用于通过单个API请求发送多个序列化模型和/或查询集。

0 10 分享