Link header based pagination

[tanoc]

Is there a way to support link header based pagination (something like this) using a custom pagination class? I'm probably missing something but I'm not seeing how to change response headers from there.

[vitalik]

@tanoc

I guess you can make some decorator that will add link header

from ninja.pagination import paginate
from ninja.decorators import decorate_view


def add_link_header(func):
     def wrapper(request, *a, **kw):
          response = func(request, *a, **kw)
          response.headers['link'] = 'xxxx' # <-- TODO
          return response
     return wrapper

@api.get('/some')
@decorate_view(add_link_header) # <--- make sure decorate on view layer
@paginate
def some(request):
      return queryset

[tanoc]

Thanks, but I would still need to be able to access the paginator object to know for example the page number (to set for example previous and next page links). I could probably attach the custom paginator to the request object, but it would be kinda ugly and I'm not sure how stable it will be.

Maybe having access to the response object (like this) in the paginator object (paginate_queryset) could be an idea?

[vitalik]

I do not yet see way to access response in paginate_quryset...

but in decorator you can:

def add_link_header(func):
     def wrapper(request, *a, **kw):
          response = func(request, *a, **kw)
          page = request.GET['page'] # <-------------------
          response.headers['link'] = 'xxxx'
          return response
     return wrapper

[tanoc]

yes, that's what I thought. but maybe it could be useful to be able to access it in the next versions. and it's not just the page number, but I would probably need info from the paginator like knowing if there is a next page or not.