Skip to main content

Pagination

Implement pagination on your project with paginate method.

paginate()​

from modules.user.models import User
from django_petra.paginate import paginate
from modules.user.serializer import UserSerializer
from django_petra.petra_core import Response, ViewSet, status

class UserViewset(ViewSet):
  def get_users(self, request):
    query = User
    query = query.objects.filter().order_by('-created')
    query = query.all()
    
    # pagination
    data = paginate(request=request, queryset=query, serializer_class=UserSerializer, per_page=4, wrap='users')

    return Response(data, status=status.HTTP_200_OK)

Paginate Parameters​

  • request: The Django HttpRequest object.
  • queryset: The queryset to be paginated.
  • serializer_class: The DRF serializer class used to serialize the paginated data.
  • per_page (optional): The number of items to display per page. Default per_page 10.
  • wrap (optional): The key to wrap the serialized data in the response. Default wrap is 'data'.

sample json data​

api endpoint
http://localhost:8000/user/get?page=1&per_page=10
{
    "per_page": 10,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "total": 0,
    "from": 0,
    "to": 0,
    "users": []
}