Django Rest framework视图-----GenericAPIView

GenericAPIView

rest_framework.generics.GenericAPIView

继承自APIVIew，增加了对于列表视图和详情视图，通用的支持方法，通常使用可以搭配一个或多个Mixin扩展类

提供的关于序列化器使用的属性与方法

支持定义的属性：

• 列表视图与详情视图通用：
  • queryset 指明使用的数据查询集
  • serializer_class 指明视图使用的序列化器
• 列表视图使用：
  • pagination_class 指明分页控制类
  • filter_backends 指明过滤控制后端
• 详情页视图使用
  • lookup_field 查询单一数据库对象是使用的条件字段，默认为'pk'
  • look_up_url_kwarg 查询单一数据是URL中的参数关键字名称，默认与lookup_field相同

提供方法：

• 列表视图与详情视图通用：

  • get_serializer_class(self)

    返回序列化器类，默认返回serializer_class，可以重写

  • get_queryset(self)

    返回视图使用的查询集，主要用来提供给Mixin扩展类使用，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写

  • get_serializer(self, args, *kwargs)

    返回序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。

    注意，该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。

    • request 当前视图的请求对象

    • view 当前请求的类视图对象

    • format 当前请求期望返回的数据格式

• 详情视图使用：

  • get_object(self)

    返回详情视图所需的模型类数据对象，主要用来提供给Mixin扩展类使用。

    在试图中可以调用该方法获取详情信息的模型类对象。

    若详情访问的模型类对象不存在，会返回404。

    该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。

代码应用：

• 列表数据

from rest_framework.response import Response
from rest_framework.generics import GenericAPIView

from .models import BookInfo, HeroInfo
from .serializers import BookInfoSerializer

# GET /books/
class BookListGenericAPIView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request):
        queryset = self.get_queryset()
        serializer = self.get_serializer(queryset, many=True)

        return Response(serializer.data)

• 单一数据

  from rest_framework.response import Response
  from rest_framework.generics import GenericAPIView
  
  from .models import BookInfo, HeroInfo
  from .serializers import BookInfoSerializer
  
  # GET /books/(?P<pk>)
  class BookDetailGenericAPIView(GenericAPIView):
      queryset = BookInfo.objects.all()
      serializer_class = BookInfoSerializer
  
      def get(self, request, pk):
          book = self.get_object()
          serializer = self.get_serializer(book)
          return Response(serializer.data)