- 属性:
- queryset - 用于从这个视图返回对象的查询集。通常,你必须设置这个属性,或者重写get_queryset ()方法。如果你重写了一个视图方法,重要的是你调用get_queryset ()而不是直接访问这个属性,因为queryset只会被评估一次,然后缓存给所有后续的请求。
- serializer_class - 用于验证和反序列化输入,以及序列化输出的序列化器类。通常,你必须设置这个属性,或者重写get_serializer_class ()方法。
- lookup_field - 用于从URL中获取对象的关键字参数的名称。默认是’pk’。
- lookup_url_kwarg - 用于从URL中获取对象的关键字参数的名称。如果没有设置,将使用lookup_field作为默认值。
- filter_backends - 用于过滤查询集的过滤器后端列表。
- pagination_class - 用于分页查询集的分页器类。
- 方法:
- get_object (self) - 返回视图所代表的对象。如果没有找到对象,将抛出一个404错误。
- get_queryset (self) - 返回视图所使用的查询集。默认返回queryset属性的值,如果没有设置,则抛出一个异常。
- get_serializer (self, args, **kwargs) - 返回一个序列化器实例。默认使用serializer_class属性创建一个序列化器,并传递给它args和**kwargs作为参数。
- get_serializer_class (self) - 返回视图所使用的序列化器类。默认返回serializer_class属性的值,如果没有设置,则抛出一个异常。
- filter_queryset (self, queryset) - 对给定的查询集应用任何过滤器后端。默认使用filter_backends属性中指定的过滤器后端。
- paginate_queryset (self, queryset) - 对给定的查询集应用分页。默认使用pagination_class属性中指定的分页器类。
- get_paginated_response (self, data) - 返回一个分页后的响应对象。默认使用pagination_class属性中指定的分页器类的get_paginated_response ()方法。
from django.contrib.auth.models import User
from myapp.serializers import UserSerializer
from rest_framework import generics
from rest_framework.permissions import IsAdminUser
class UserList(generics.GenericAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
permission_classes = [IsAdminUser]
def get(self, request, *args, **kwargs):
# 获取查询集并过滤、分页
queryset = self.filter_queryset(self.get_queryset())
page = self.paginate_queryset(queryset)
if page is not None:
# 如果有分页,返回分页后的响应
serializer = self.get_serializer(page, many=True)
return self.get_paginated_response(serializer.data)
# 如果没有分页,返回全部数据
serializer = self.get_serializer(queryset, many=True)
return Response(serializer.data)
def post(self, request, *args, **kwargs):
# 获取并验证输入数据
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
# 创建并保存用户对象
user = serializer.save()
# 返回创建成功的响应
return Response(serializer.data, status=status.HTTP_201_CREATED)