Customization

If you don't like default Page or Params you can always create your own.

Page

In order to create custom Page you need to inherit from AbstractPage and implement create classmethod.

from __future__ import annotations
from typing import TypeVar, Generic, Sequence

from fastapi_paginate import Params
from fastapi_paginate.bases import AbstractPage, AbstractParams

T = TypeVar("T")


class Page(AbstractPage[T], Generic[T]):
    results: Sequence[T]

    __params_type__ = Params  # Set params related to Page

    @classmethod
    def create(
            cls,
            items: Sequence[T],
            total: int,
            params: AbstractParams,
    ) -> Page[T]:
        return cls(results=items)

Then it can be used in routes:

@app.get("/", response_model=Page[User])
async def route():
    ...

JSON:API custom Page example

To extend the default Page with additional params, like the JSON:API schema, try the example below:

from typing import TypeVar, Generic

from fastapi_paginate.links import Page

T = TypeVar("T")


class JsonApiPage(Page[T], Generic[T]):
    """JSON:API 1.0 specification says that result key should be a `data`."""

    class Config:
        allow_population_by_field_name = True
        fields = {"items": {"alias": "data"}}

Params

To create a custom Params you should inherit from AbstractParams and implement to_raw_params method.

from pydantic import BaseModel

from fastapi_paginate.bases import RawParams, AbstractParams


class Params(BaseModel, AbstractParams):
    total_items: int
    return_per_page: int

    def to_raw_params(self) -> RawParams:
        return RawParams(
            limit=self.total_items,
            offset=self.total_items * self.return_per_page,
        )

Custom Params values

from typing import TypeVar, Generic

from fastapi import Query

from fastapi_paginate.default import Page as BasePage, Params as BaseParams

T = TypeVar("T")


class Params(BaseParams):
    size: int = Query(500, ge=1, le=1_000, description="Page size")


class Page(BasePage[T], Generic[T]):
    __params_type__ = Params