fastapi-pagination 0.3.1

FastAPI pagination

FastAPI Pagination

Installation

Basic version

pip install fastapi-pagination

Gino integration

pip install fastapi-pagination[gino]

SQLAlchemy integration

pip install fastapi-pagination[sqlalchemy]

Example

from fastapi import FastAPI, Depends
from pydantic import BaseModel

from fastapi_pagination import PaginationParams, Page
from fastapi_pagination.paginator import paginate

app = FastAPI()

class User(BaseModel):
    name: str
    surname: str

users = [
    User(name='Yurii', surname='Karabas'),
    # ...
]

@app.get('/users', response_model=Page[User])
async def get_users(params: PaginationParams = Depends()):
    return paginate(users, params)