GenericAPIView

GenericAPIView

rest_framework.generics.GenericAPIView

Generic：通用的，一般的

• 作用： 通常结合一个或多个Mixin扩展类使用，用来快速地实现列表视图或详情视图，即标准的增删改查功能。
• 与APIView的不同点：主要增加了 操作序列化器 和 数据库查询的属性或方法，为Mixin扩展类的执行提供支持。

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

• 属性：

  • serializer_class 指明视图使用的序列化器

• 方法：

  • get_serializer_class(self)

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

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

  • get_serializer(self, args, *kwargs)

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

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

    • request 当前视图的请求对象
    • view 当前请求的类视图对象
    • format 当前请求期望返回的数据格式

提供的关于数据库查询的属性与方法

• 属性：

  • queryset 指明使用的数据查询集

• 方法：

  • get_queryset(self)

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

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

  • get_object(self)

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

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

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

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

案例：查询一个部门

# 方式1
class DepartmentDetailView(APIView):
    def get(self, request, pk):
         dep = Department.objects.get(id=pk)
         serializer = DepartmentSerializer(dep)
         return Response(serializer.data)

# 方式2        
class DepartmentDetailView(GenericAPIView):    
    # lookup_field = 'id'    # 默认为pk
    queryset = Department.objects.all()
    serializer_class = DepartmentSerializer

    def get(self, request, pk):
        dep = self.get_object()  # get_object()方法根据pk参数查找queryset中的数据对象
        serializer = self.get_serializer(dep)
        return Response(serializer.data)

# 路由配置    
url(r'^departments/(?P<pk>\d+)/$', views.DepartmentDetailView.as_view()),
# url(r'^departments/(?P<id>\d+)/$', views.DepartmentDetailView.as_view()),