pypaginate.adapters.fastapi.dependencies

FastAPI pagination dependencies.

Provides Annotated type aliases for clean dependency injection:

from pypaginate.adapters.fastapi import OffsetDep, CursorDep


@app.get("/users")
async def get_users(params: OffsetDep) -> OffsetPage[User]:
    return paginate(users, params)

Attributes

`CursorDep`	Annotated type for cursor pagination dependency.
`OffsetDep`	Annotated type for offset pagination dependency.

Module Contents

pypaginate.adapters.fastapi.dependencies.CursorDep

Annotated type for cursor pagination dependency.

Usage:

@app.get("/users/scroll")
async def scroll(params: CursorDep) -> CursorPage[User]:
    return await paginate(query, params, backend=backend)

pypaginate.adapters.fastapi.dependencies.OffsetDep

Annotated type for offset pagination dependency.

Usage:

@app.get("/users")
async def get_users(params: OffsetDep) -> OffsetPage[User]:
    return paginate(users, params)