一级类视图
APIView
from rest_framework.views import APIView
APIView
是REST framework提供的所有视图的基类,继承自Django的View
父类。
APIView
与View
的不同之处在于:
- 传入到视图方法中的是REST framework的
Request
对象,而不是Django的HttpRequeset
对象; - 视图方法可以返回REST framework的
Response
对象,视图会为响应数据设置(render)符合前端要求的格式; - 任何
APIException
异常都会被捕获到,并且处理成合适的响应信息; - 在进行dispatch()分发前,会对请求进行身份认证、权限检查、流量控制。
支持定义的属性:
- authentication_classes列表或元祖,身份认证类
- permissoin_classes列表或元祖,权限检查类
- throttle_classes列表或元祖,流量控制类
class AdM(APIView):
def get(self,request):
ad = Ad.objects.all()
ser = AdSer(ad,many=True)
return Response(ser.data)
def post(self,request):
ser = AdSer(data=request.data)
if ser.is_valid():
ser.save()
return Response({"code":200})
二级视图
GenericAPIView
继承自
APIVIew,增加了对于列表视图和详情视图可能用到的通用支持方法。通常使用时,可搭配一个或多个Mixin扩展类。
使用GenericAPIView类一般需要实现queryset属性或者重写get_queryset方法
支持定义的属性:
- 列表视图与详情视图通用:
- queryset列表视图的查询集
- serializer_class视图使用的序列化器
- 列表视图使用:
- pagination_class分页控制类
- filter_backends过滤控制后端
- 详情页视图使用:
- lookup_field查询单一数据库对象时使用的条件字段,默认为’
pk
’ - lookup_url_kwarg查询单一数据时URL中的参数关键字名称,默认与look_field相同
- lookup_field查询单一数据库对象时使用的条件字段,默认为’
提供的方法:
-
列表视图与详情视图通用:
-
get_queryset(self)
返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回
queryset
属性,可以重写,例如:def get_queryset(self): user = self.request.user return user.accounts.all()
-
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)
返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。
注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。
-
-
详情视图使用:
-
**get_object(self)**返回详情视图所需的模型类数据对象,默认使用
lookup_field
参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。若详情访问的模型类对象不存在,会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
-
添加展示实现
class AdGeneric(GenericAPIView):
queryset = Ad.objects.all()
serializer_class = AdSer
def get(self,request):
ad = self.get_queryset()
ser = self.get_serializer(ad,many=True)
return Response(ser.data)
def post(self,request):
ser = self.get_serializer(data=request.data)
if ser.is_valid():
ser.save()
return Response({"code":200})
Mixin
ListModelMixin
列表视图扩展类,提供list(request, *args, **kwargs)
方法快速实现列表视图,返回200状态码。
该Mixin的list方法会对数据进行过滤和分页
from rest_framework.pagination import PageNumberPagination
#分页
class PageClass(PageNumberPagination):
page_size=1
from rest_framework.mixins import ListModelMixin
class AdMixin(GenericAPIView,ListModelMixin):
queryset = Ad.objects.all()
serializer_class = AdSer
pagination_class = Pages
def get(self,request):
return self.list(request)
CreateModelMixin
创建视图扩展类,提供create(request, *args, **kwargs)
方法快速实现创建资源的视图,成功返回201状态码。
如果序列化器对前端发送的数据验证失败,返回400错误。
from rest_framework.mixins import CreateModelMixin
class AdMixin(GenericAPIView,CreateModelMixin):
queryset = Ad.objects.all()
serializer_class = AdSer
def post(self,request):
return self.create(request)
UpdateModelMixin
更新视图扩展类,提供update(request, *args, **kwargs)
方法,可以快速实现更新一个存在的数据对象。
同时也提供partial_update(request, *args, **kwargs)
方法,可以实现局部更新。
成功返回200,序列化器校验数据失败时,返回400错误。
#re_path('admodify/(?P<pk>\d+)/$',AdMixin.as_view())
from rest_framework.mixins import UpdateModelMixin
class AdMixin(GenericAPIView,UpdateModelMixin):
queryset = Ad.objects.all()
serializer_class = AdSer
def put(self,request,pk):
return self.update(request)
DestroyModelMixin
删除视图扩展类,提供destroy(request, *args, **kwargs)
方法,可以快速实现删除一个存在的数据对象。
成功返回204,不存在返回404。
from rest_framework.mixins import DestroyModelMixin,ListModelMixin
class AdMixin(GenericAPIView,DestroyModelMixin,ListModelMixin):
queryset = Ad.objects.all()
serializer_class = AdSer
def get(self,request):
return self.list(request)
def delete(self,request,pk):
return self.destroy(request)
RetrieveModelMixin
详情视图扩展类,提供retrieve(request, *args, **kwargs)
方法,可以快速实现返回一个存在的数据对象。
如果存在,返回200, 否则返回404。
from rest_framework.mixins import RetrieveModelMixin
class AdMixin(GenericAPIView,RetrieveModelMixin):
queryset = Ad.objects.all()
serializer_class = AdSer
def get(self,request,pk):
return self.retrieve(request)
子类视图(三级)
CreateAPIView
提供 post 方法
继承自: GenericAPIView、CreateModelMixin
class TeacherCreateView(CreateAPIView):
serializer_class = TeacherCreateSer
ListAPIView
提供 get 方法
继承自:GenericAPIView、ListModelMixin
class TeacherListView(ListAPIView):
queryset = Teacher.objects.all() # 你要序列化的哪些数据结果
serializer_class = TeacherListSer # 用什么序列化器
RetireveAPIView
提供 get 方法
继承自: GenericAPIView、RetrieveModelMixin
class GenericList(RetrieveAPIView):
queryset = Dept.objects.all()
serializer_class = DeptSer
lookup_field='id'
DestroyAPIView
提供 delete 方法
继承自:GenericAPIView、DestoryModelMixin
class GenericList(DestroyAPIView):
queryset = Dept.objects.all()
serializer_class = DeptSer
lookup_field='id'
UpdateAPIView
提供 put 和 patch 方法
继承自:GenericAPIView、UpdateModelMixin
class TeacherUpdateView(UpdateAPIView):
lookup_field = 'pk' # 数据库里的字段
queryset = Teacher.objects.all()
serializer_class = TeacherUpdateSer
RetrieveUpdateAPIView
提供 get、put、patch方法
继承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin
RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法
继承自:GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin