backend-filters

name	backend-filters
description	Reference for the backend filter and pagination system. Covers Filter classes, JoinFilter for cross-table queries, search fields, operator transformers, and fastapi_pagination integration. Use when adding or modifying list/search endpoints.

Backend Filters & Pagination

Overview

The backend uses fastapi_filter for query filtering and fastapi_pagination for paginated responses. Filters are declared as Pydantic-like classes and injected into routes via Depends().

Basic Filter

Create a Filter class per module in filters.py:

from fastapi_filter.contrib.sqlalchemy.filter import Filter
from app.modules.your_entity.models import YourEntity

class YourEntityFilter(Filter):
    search: str | None = None
    name__like: str | None = None
    status__eq: str | None = None
    quantity__gte: int | None = None

    class Constants(Filter.Constants):
        model = YourEntity
        search_model_fields = [, ]