Rest Framework的ViewSet
一、与视图集配合使用的5个扩展类
ListModelMixin:
提供list(request, *args, **kwargs)方法快速实现列表视图,返回200状态码。该Mixin的list方法会对数据进行过滤和分页。
CreateModelMixin:
提供create(request, *args, **kwargs)方法快速实现创建资源的视图,成功返回201状态码。如果序列化器对前端发送的数据验证失败,返回400错误。
RetrieveModelMixin:
提供retrieve(request, *args, **kwargs)方法,可以快速实现返回一个存在的数据对象。如果存在,返回200, 否则返回404。
UpdateModelMixin:
提供update(request, *args, **kwargs)方法,可以快速实现更新一个存在的数据对象。同时也提供供 partial_update(request, *args, **kwargs)方法,更新部分字段,可以实现局部更新。成功返回200,序列化器校验数据失败时,返回400错误。
DestroyModelMixin:
提供destroy(request, *args, **kwargs)方法,可以快速实现删除一个存在的数据对象。成功返回204,不存在返回404。
二、几个可用子类视图
1) CreateAPIView
提供 post 方法
继承自: GenericAPIView、CreateModelMixin
2)ListAPIView
提供 get 方法
继承自:GenericAPIView、ListModelMixin
3)RetireveAPIView
提供 get 方法
继承自: GenericAPIView、RetrieveModelMixin
4)DestoryAPIView
提供 delete 方法
继承自:GenericAPIView、DestoryModelMixin
5)UpdateAPIView
提供 put 和 patch 方法
继承自:GenericAPIView、UpdateModelMixin
三、视图集ViewSet
使用视图集ViewSet,可以将一系列逻辑相关的动作放到一个类中:
- list() 提供一组数据
- retrieve() 提供单个数据
- create() 创建数据
- update() 保存数据
- destory() 删除数据
ViewSet继承自ViewSetMixin和views.APIView。因为ViewSetMixin里重写了as_view方法,所以ViewSet视图集类不再实现get()、post()等方法,而是实现动作 action 如 list() 、create() 等。视图集在使用as_view()方法的时候定义好action与请求方式的对应关系,才能将action动作与具体请求方式对应上。
路由设置如下:
def get_serializer_class(self):
if self.action == 'names':
return ProjectsNamesModelSerializer
elif self.action == 'interfaces':
return InterfacesByProjectIdModelSerializer
常用视图集父类
1) ViewSet
继承自ViewSetMixin和APIView,作用也与APIView基本类似,提供了身份认证、权限校验、流量管理等。
在ViewSet中,没有提供任何动作action方法,需要我们自己实现action方法。
2)GenericViewSet(ViewSetMixin, generics.GenericAPIView)
继承自ViewSetMixin和GenericAPIView,作用也与GenericAPIVIew类似,提供了get_object、get_queryset等方法便于列表视图与详情信息视图的开发。
ViewSetMixin重写了as_view方法,支持指定请求方法和action的映射
GenericAPIView继承自APIView,拓展了对查询集的过滤排序和分页的实现,所以GenericViewSet实现了查询集的过滤、排序和分页的功能
3)ModelViewSet
继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin,支持create、list、retrieve、update、partial_update以及destroy这6个action
4)ReadOnlyModelViewSet
继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin。
几种ViewSet类的关系图:
视图集中定义附加action动作
在视图集中,除了上述默认的方法动作外,还可以添加自定义动作。
添加自定义动作需要使用rest_framework.decorators.action装饰器。
以action装饰器装饰的方法名会作为action动作名,与list、retrieve等同。
action装饰器可以接收两个参数:
- methods: 该action支持的请求方式,列表传递,默认为get
- detail: 表示是action中要处理的是否是视图资源的对象(即是否通过url路径获取主键)
- True 表示使用通过URL获取的主键对应的数据对象
- False 表示不使用URL获取主键
from projects import views
urlpatterns = [
path('projects/names/', views.ProjectsViewSet.as_view({
'get': 'names'
})),
path('projects//interfaces/', views.ProjectsViewSet.as_view({
'get': 'interfaces'
})),
path('projects//run/', views.ProjectsViewSet.as_view({
'post': 'run'
})),
]