Django Rest 框架：在视图集上打开分页（如模型视图集分页）

Question

我有一个这样的视图集来列出用户的数据:

class Foo(viewsets.ViewSet):

    def list(self, request):
        queryset = User.objects.all()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

我想打开分页，就像模型视图集的默认分页一样：

{
    "count": 55,
    "next": "http://myUrl/?page=2",
    "previous": null,
    "results": [{...},{...},...,{...}]
}

官方文档说：

只有在使用通用视图或视图集时，分页才会自动执行

…但我的结果集根本没有分页。如何为其分页？

Answer 1

尝试提供类变量

paginate_by = 10 #This will paginate by 10 results per page.

创建一个自定义的< code >视图集,它只执行< code >列表操作，就像您当前在这里的情况一样。

class ListModelViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):
    pass

现在，使用此自定义视图集继承您的类 Foo

class Foo(ListModelViewSet):

    paginate_by = 10

    def list(self, request):
        queryset = User.objects.all()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

这将有助于分页工作。

Answer 2

只有在使用通用视图或视图集时，分页才会自动执行

第一个障碍是将文档翻译成英语。他们想要传达的是你想要一个通用的视图集。通用视图集是从通用的ApiViews扩展而来的，通用的ApiViews有额外的类方法来分页查询集和响应。

此外，您提供了自己的list方法，但默认分页过程实际上是由mixin处理的：

class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(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)

简单的解决方案是使用框架代码:

class Foo(mixins.ListModelMixin, viewsets.GenericViewSet):
    queryset = User.objects.all()
    serializer = UserSerializer

更复杂的解决方案是，如果您需要自定义列表方法，那么您应该按照您认为合适的方式编写它，但采用上述mixin代码片段的样式。

Answer 3

对于使用DRF 3.1或更高版本的用户，他们正在更改处理分页的默认方式。看见http://www.django-rest-framework.org/topics/3.1-announcement/了解详细信息。

现在，如果您想为ModelViewSet启用分页，您可以通过在settings.py文件中设置全局分页：

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 100
}

或者，如果您只想将其用于一个ModelViewSet，您可以手动为该视图集设置pagination_class。

from rest_framework.pagination import PageNumberPagination

class StandardResultsSetPagination(PageNumberPagination):
    page_size = 100
    page_size_query_param = 'page_size'
    max_page_size = 1000

class FooViewSet(viewsets.ModelViewSet):
    pagination_class = StandardResultsSetPagination

这还允许您调整仅为该视图集处理分页的方式。

DRF 3.1还引入了您可以使用的新类型的默认分页方案，例如LimitOffset和Cursor。