一、继承关系
APIView是REST framework提供的所有视图的基类,继承自Django的View父类。
GenericAPIView(rest_framework.generics.GenericAPIView)
继承自APIVIew,增加了对于列表视图和详情视图可能用到的通用支持方法(对列表数据进行过滤、排序、分页操作)。通常使用时,可搭配一个或多个Mixin扩展类。
二、GenericAPIView
支持定义的属性:
列表视图与详情视图通用:
- queryset 列表视图的查询集
- serializer_class 视图使用的序列化器
列表视图使用:
- pagination_class 分页控制类
- filter_backends 过滤控制后端
详情页视图使用:
- lookup_field 查询单一数据库对象时使用的条件字段,默认为'pk'
- lookup_url_kwarg 查询单一数据时URL中的参数关键字名称,默认与look_field相同
提供的方法:
列表视图与详情视图通用:
- get_queryset(self)
返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写,例如:
- get_serializer_class(self)
返回序列化器类,默认返回serializer_class,可以重写,例如:
- get_serializer(self, args, *kwargs)
返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。
注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。
详情视图使用:
get_object(self) 返回详情视图所需的模型类数据对象,默认使用lookup_field参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。
若详情访问的模型类对象不存在,会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
举例:
Rest Framework视图集的路由设置
问题
在使用DRF视图集时,往往需要配一大堆路由,实在是太麻烦了。例如:
解决方式
对于视图集ViewSet,我们除了可以自己手动指明请求方式与动作action之间的对应关系外,还可以使用Routers来帮助我们快速实现路由信息。
REST framework提供了两个router
- SimpleRouter
- DefaultRouter
Routers路由使用方法
1.创建router对象,并注册视图集。
register(prefix, viewset, base_name)方法说明:
- prefix 该视图集的路由前缀
- viewset 视图集
- base_name 路由名称的前缀
2.添加路由数据
DefaultRouter与SimpleRouter的区别是,DefaultRouter会多附带一个默认的API根视图,返回一个包含所有列表视图的超链接响应数据。