Optional pagination

Is it possible to create a route that would return a paginated result if some params where passed, and a non-paginated result otherwise? It looks like add_pagination inspects the response_model, so I’m not sure how it can be done.

[uriyyo]

Hi @davidbrochart @marioland ,

With version 0.11.0 you can achieve this using pagination_ctx function:

from typing import Union, List, Literal, Any

from fastapi import FastAPI, Depends, Query

from fastapi_pagination import Page, paginate, pagination_ctx

app = FastAPI()


@app.get(
    "/",
    response_model=Union[Page[int], List[int]],
    dependencies=[Depends(pagination_ctx(Page[int]))],
)
async def route(
    response_type: Literal["page", "list"] = Query(...),
) -> Any:
    data = [*range(100)]

    if response_type == "page":
        return paginate(data)

    return data


if __name__ == '__main__':
    import uvicorn

    uvicorn.run(app)

[uriyyo]

Hi @davidbrochart, I am closing this issue, please reopen it if you have more questions.