视图
一、两个基类
一级视图APIView——不考虑数据库查询,序列化器使用时继承此视图。
1、传入到视图方法中的是REST framework的Request对象
2、视图方法可以返回REST framework的Response对象
3、任何APIException异常都会被捕获到,并且处理成合适的响应信息
4、在进行dispatch()分发前,会对请求进行身份认证、权限检查、流量控制
二级视图GenericView——仅对数据库查询操作,序列化器使用时继承此视图。
---分为列表视图和详情视图
1、通用属性:
queryset 列表视图的查询集
serializer_class 视图使用的序列化器
2、通用方法:
get_queryset(self)——返回视图使用的查询集,默认返回queryset属性
get_serializer_class(self)——返回序列化器类,默认返回serializer_class
get_serializer(self, args, *kwargs)——返回序列化器对象
2.1详情视图——get_object(self)
注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view(类视图对象),这三个数据对象可以在定义序列化器时使用。
django的类视图对象中,kwargs属性保存了路径提取出来的参数。
二、子类视图
提供请求方法,分别继承上面一个基类(GenericView)和扩展类
CreateAPIView
ListAPIView
RetireveAPIView
DestoryAPIView
UpdateAPIView
RetrieveUpdateAPIView
RetrieveUpdateDestoryAPIView
三、五个扩展类
1、ListModelMixin
源代码
class BookListView(ListModelMixin, GenericAPIView):
queryset = BookInfo.objects.all()
serializer_class = BookInfoSerializer
def get(self, request):
return self.list(request)
2、CreateModelMixin
3、RetrieveModelMixin
源代码
class BookDetailView(RetrieveModelMixin, GenericAPIView):
queryset = BookInfo.objects.all()
serializer_class = BookInfoSerializer
def get(self, request, pk):
return self.retrieve(request)
4、UpdateModelMixin
5、DestroyModelMixin
源代码
class DestroyModelMixin(object):
"""
Destroy a model instance.
"""
def destroy(self, request, *args, **kwargs):
instance = self.get_object()
self.perform_destroy(instance)
return Response(status=status.HTTP_204_NO_CONTENT)
四、视图集ViewSet
1、将一系列逻辑相关的动作放到一个类中,ViewSet视图集类不再实现get()、post()等方法,而是实现动作 action 如 list() 、create() 等。
list() 提供一组数据
retrieve() 提供单个数据
create() 创建数据
update() 保存数据
destory() 删除数据
2、action属性
通过action对象属性来获取当前请求视图集时的action动作是哪个
添加自定义动作需要使用rest_framework.decorators.action装饰器,action装饰器可以接收两个参数:
methods: 该action支持的请求方式,列表传递
detail: 表示是action中要处理的是否是视图资源的对象(即是否通过url路径获取主键)True 表示使用通过URL获取的主键对应的数据对象---即单数形式,要处理具体与pk主键对应的BookInfo对象
@action(methods=['put'], detail=True)
def read(self, request, pk):
"""修改图书的阅读量数据"""
book = self.get_object()
book.bread = request.data.get('read')
serializer = self.get_serializer(book)
return Response(serializer.data)
False 表示不使用URL获取主键---即复数形式,不需要详情
@action(methods=['get'], detail=False)
def latest(self, request):
"""返回最新的图书信息"""
book = BookInfo.objects.latest('id')
serializer = self.get_serializer(book)
return Response(serializer.data)
3、常用视图集父类
GenericViewSet——继承自GenericAPIView,提供了get_object、get_queryset等方法
ModelViewSet——继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin
ReadOnlyModelViewSet——继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin
4、路由router
作用--简化路由,方便视图集快速实现路由
创建router对象,并注册视图集
from rest_framework import routers
router = routers.SimpleRouter()
router.register(r'books', BookInfoViewSet, base_name='book')
添加路由数据---两种方式
第一种:urlpatterns =[...]
urlpatterns += router.urls
第二种:urlpatterns = [
url(r'^', include(router.urls))
]