Django的REST框架：打開分頁上一個視圖集（如ModelViewSet分頁）

Question

我有一個視圖集中這樣一個列出用戶的數據：

class Foo(viewsets.ViewSet): 

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

我想打開分頁像ModelViewSet默認分頁：

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

The official doc說：

Pagination is only performed automatically if you're using the generic views or viewsets

...但我的結果集我根本沒有分頁。我如何分頁？

Answer 1

Pagination is only performed automatically if you're using the generic views or viewsets

第一個路障是將文檔翻譯成英文。他們打算傳達的是你想要一個通用的視圖集。通用視圖集擴展自generic 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 

更復雜的解決方案是，如果您需要自定義list方法，那麼您應該按照您認爲合適的方式編寫它，但採用上述mixin代碼片段的樣式。

Answer 2

嘗試提供一個類變量

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

創建自定義ViewSet僅執行list操作的情況下，這裏現在。

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 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。使用viewsets和列表

Answer 4

分頁中DRF

在這裏，我已經處理了異常，如果頁面是空的，它會顯示空記錄

在設置定義頁面大小，該頁面大小是全球性的，它是用來通過在視圖

rEST_FRAMEWORK = { 'PAGE_SIZE'：10，} paginator_queryset

鑑於 從rest_framework進口混入，viewsets

class SittingViewSet(viewsets.GenericViewSet, 
    mixins.ListModelMixin): 

    serializer_class = SittingSerializer 
    queryset = Sitting.objects.all() 
    serializer = serializer_class(queryset, many=True) 

    def list(self, request, *args, **kwargs): 
     queryset =self.filter_queryset(Sitting.objects.all().order_by('id')) 

     page = request.GET.get('page') 

     try: 
      page = self.paginate_queryset(queryset) 
     except Exception as e: 
      page = [] 
      data = page 
      return Response({ 
       "status": status.HTTP_404_NOT_FOUND, 
       "message": 'No more record.', 
       "data" : data 
       }) 

     if page is not None: 
      serializer = self.get_serializer(page, many=True) 
      data = serializer.data 
      return self.get_paginated_response(data) 

     # serializer = self.get_serializer(queryset, many=True) 
     return Response({ 
      "status": status.HTTP_200_OK, 
      "message": 'Sitting records.', 
      "data" : data 
     }) 

**>注意：如果你不使用ORDER_BY它會顯示異常，因爲這個名單

給無序列表**