18.6. Ninja Pagination¶

Source: https://django-ninja.dev/guides/response/pagination/
Checkout: https://petersimpson.dev/blog/trying-out-django-ninja/

18.6.1. LimitOffsetPagination¶

/api/users?limit=10&offset=0
settings.NINJA_PAGINATION_PER_PAGE = 100

from ninja.pagination import paginate

@api.get('/users', response=List[UserSchema])
@paginate
def list_users(request):
    return User.objects.all()

curl http://127.0.0.1:8000/api/users?limit=10&offset=0

18.6.2. PageNumberPagination¶

from ninja.pagination import paginate, PageNumberPagination

@api.get('/users', response=list[UserSchema])
@paginate(PageNumberPagination, page_size=10)
def list_users(request):
    return User.objects.all()

curl http://127.0.0.1:8000/api/users?page=2

18.6.3. Use Case - 0x01¶

>>> 
... from django.http import HttpRequest
... from ninja import Router
... from ninja.pagination import paginate, PageNumberPagination
... from shop.models import Product
... from shop.schemas import ProductSchema
...
...
... router = Router()
...
...
... @router.get('/products', response=list[ProductSchema])
... @paginate(PageNumberPagination, page_size=5)
... def products_list(request: HttpRequest):
...     products = Product.objects.all().values('name', 'price', 'ean13')
...     return list(products)