一、请求(Request)
REST_FRAMEWORK中的Request
视图类(APIView/@api_view)
1.类基础视图(APIView)
- 封装了Response对象,代替了原有的django HttpResponse
- 提供了更好用的request对象,不同于普通的django HttpRequest更好用
API策略属性
class ListUser(APIView):
authentication_classes = (authentication.TokenAuthentication,) # 认证策略属性
permission_classes = (permissions.IsAdminUser,) # 权限策略属性
def get(self, requeset, format=None):
"""
只有admin访问
get请求返回一个用户列表
"""
usernames = [user.username for user in User.objects.all()]
return Response(usernames)
authentication_classes: 权限类
对于FBV,则可以利用DRF中的装饰器@api_view使用DRF
对于一些其他的权限,认证,只是利用不同的装饰器即可
from rest_framework.decorators import api_view
@api_view
def hello_world(request):
return Response({“message”:”Hello world!”})
通用视图(Generic views)
GenericAPIView继承了DRF的APIView类,为list和detail视图增加了一些一般需求行为方法(提供queryset)
基本属性
queryset: 用于返回query对象集合,也可以使用get_queryset()方法。
`authentication_classes = (authentication.TokenAuthentication,)` # 认证策略属性
`permission_classes = (permissions.IsAdminUser,)`# 权限策略属性
serializer_class: 序列化器类,应该用于输入进行验证和反序列化,并用于序列化输出。
通常情况下,你必须设置这个属性,或重写get_serializer_class()方法,(在serializers.py,对数据添加功能)
分页属性:
pagination_class: 用于返回一个分页列表视图的分页类,默认与settings中设置的DEFAULT_PAGINATION_CLASS 值相同,
可以通过’rest_framework.pagination.PageNumberPagination’设置分页数
permission_classes = [IsAdminUser]权限
过滤器属性:
filter_backends: 过滤queryset的类列表,和在settings中设置DEFAULT_FILTER_BACKENDS 一样
基本方法:
get_queryset(): 返回queryset
def get_queryset(self):
user = self.request.user
return user.accounts.all()
get_object():获取某一个具体的model实例对象
mixin类提供用于提供基础视图的操作行为
ListModelMixin:提供list方法,列出queryset
CreateModelMixin: 提供create方法,创建和保存一个Model对象
RetrieveModelMixin:提供retrieve方法,检索一个存在的model对象
UpdateModelMixin: 提供Update方法,更改一个模型对象
DestroyModelMixin:提供destroy方法,删除一个模型对象
RetrieveModelMixin
class UpdateModelMixin(object):
"""
Update a model instance.==> 更新某个具体对象的内容
"""
def update(self, request, *args, **kwargs):
partial = kwargs.pop('partial', False)
instance = self.get_object()
serializer = self.get_serializer(instance, data=request.data, partial=partial)
serializer.is_valid(raise_exception=True)
self.perform_update(serializer)
if getattr(instance, '_prefetched_objects_cache', None):
# If 'prefetch_related' has been applied to a queryset, we need to
# forcibly invalidate the prefetch cache on the instance.
instance._prefetched_objects_cache = {}
return Response(serializer.data)
def perform_update(self, serializer):
serializer.save()
def partial_update(self, request, *args, **kwargs):
kwargs['partial'] = True
return self.update(request, *args, **kwargs)
Generic
视图集合ViewSets
`viewsets.ViewSet:`
继承了APIView
`viewsets.GenericViewSet:`
继承了GenericAPIView,提供了默认的get_queryset()和get_object()等方法来获取model数据,但不提供任何请求处理方法
继承了GenericAPIView,增加了一些请求处理方法,如list(), retrieve(),create()等。
`.ReadOnlyModelViewSet:`
继承了GenericAPIView,只增加了只读的请求处理方法list()和retrieve()
注册路由
from rest_framework import routers
from django.urls import path, include
router = routers.SimpleRouter()
router.register(r’users’, UserViewSet, ‘users’)
router.register(r’accounts’, AccountViewSet)
urlpatterns =[ path('api/',include(router.urls) ]
generics.ListCreateAPIView
class UserList(generics.ListCreateAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
permission_classes = [IsAdminUser]
def list(self, request):
# Note the use of `get_queryset()` instead of `self.queryset`
queryset = self.get_queryset()
serializer = UserSerializer(queryset, many=True)
return Response(serializer.data)
网友评论