Adding filter capacities to api client and server

api/app/category/models.py

@@ -1,6 +1,8 @@
 from uuid import UUID, uuid4
 from enum import Enum
+from typing import Optional
 
+from fastapi_filter.contrib.sqlalchemy import Filter
 from sqlmodel import Field, SQLModel, select
 
 class CategoryBase(SQLModel):
@@ -21,8 +23,8 @@ class Category(CategoryRead, table=True):
         return category_db
 
     @classmethod
-    def list(cls):
-        return select(Category)
+    def list(cls, filters):
+        return filters.filter(select(cls))
 
     @classmethod
     def get(cls, session, category_id):
@@ -49,3 +51,10 @@ class CategoryCreate(CategoryWrite):
 
 class CategoryUpdate(CategoryWrite):
     pass
+
+class CategoryFilters(Filter):
+    name__like: Optional[str] = None
+
+    class Constants(Filter.Constants):
+        model = Category
+        search_model_fields = ["name"]

api/app/category/routes.py

@@ -1,11 +1,12 @@
 from uuid import UUID
 
-
 from fastapi import APIRouter, HTTPException, Depends
+from fastapi_filter import FilterDepends
 from fastapi_pagination import Page
 from fastapi_pagination.ext.sqlmodel import paginate
+from pydantic import BaseModel
 
-from category.models import Category, CategoryCreate, CategoryRead, CategoryUpdate
+from category.models import Category, CategoryCreate, CategoryRead, CategoryUpdate, CategoryFilters
 from db import SessionDep
 from user.manager import get_current_user
 
@@ -17,8 +18,10 @@ def create_category(category: CategoryCreate, session: SessionDep, current_user=
     return category
 
 @router.get("")
-def read_categories(session: SessionDep, current_user=Depends(get_current_user)) -> Page[CategoryRead]:
-    return paginate(session, Category.list())
+def read_categories(session: SessionDep,
+                    filters: CategoryFilters = FilterDepends(CategoryFilters),
+                    current_user=Depends(get_current_user)) -> Page[CategoryRead]:
+    return paginate(session, Category.list(filters))
 
 @router.get("/{category_id}")
 def read_category(category_id: UUID, session: SessionDep, current_user=Depends(get_current_user)) -> CategoryRead: