Merge pull request #89 from carvalhocaio/main

feat: add pagination to item endpoint by using fastapi-pagination

Author: andersonresende

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ fail_fast: true
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
         args: ["--maxkb=500"]
@@ -19,7 +19,7 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.1.8
+    rev: v0.12.2
     hooks:
       # Run the linter.
       - id: ruff

CHANGELOG.md

@@ -7,6 +7,10 @@ frontend TypeScript client, `nextjs-frontend`.
     The backend and the frontend are versioned together, that is, they have the same version number.
     When you update the backend, you should also update the frontend to the same version.
 
+## 0.0.5 <small>July 9, 2025</small> {id="0.0.5"}
+
+- Items Pagination
+
 ## 0.0.4 <small>July 9, 2025</small> {id="0.0.4"}
 
 - Fix ESlint missing for pre-commit

fastapi_backend/alembic_migrations/versions/402d067a8b92_added_user_table.py

@@ -1,10 +1,11 @@
 """Added user table
 
 Revision ID: 402d067a8b92
-Revises: 
+Revises:
 Create Date: 2024-09-27 14:01:44.155160
 
 """
+
 from typing import Sequence, Union
 
 import fastapi_users_db_sqlalchemy

fastapi_backend/alembic_migrations/versions/b389592974f8_add_item_model.py

@@ -5,6 +5,7 @@
 Create Date: 2024-12-06 17:52:50.698249
 
 """
+
 from typing import Sequence, Union
 
 from alembic import op

fastapi_backend/app/main.py

@@ -1,4 +1,5 @@
 from fastapi import FastAPI
+from fastapi_pagination import add_pagination
 from .schemas import UserCreate, UserRead, UserUpdate
 from .users import auth_backend, fastapi_users, AUTH_URL_PATH
 from fastapi.middleware.cors import CORSMiddleware
@@ -49,3 +50,4 @@
 
 # Include items routes
 app.include_router(items_router, prefix="/items")
+add_pagination(app)

fastapi_backend/app/routes/items.py

@@ -1,6 +1,8 @@
 from uuid import UUID
 
-from fastapi import APIRouter, Depends, HTTPException
+from fastapi import APIRouter, Depends, HTTPException, Query
+from fastapi_pagination import Page, Params
+from fastapi_pagination.ext.sqlalchemy import apaginate
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.future import select
 
@@ -12,14 +14,20 @@
 router = APIRouter(tags=["item"])
 
 
-@router.get("/", response_model=list[ItemRead])
+def transform_items(items):
+    return [ItemRead.model_validate(item) for item in items]
+
+
+@router.get("/", response_model=Page[ItemRead])
 async def read_item(
     db: AsyncSession = Depends(get_async_session),
     user: User = Depends(current_active_user),
+    page: int = Query(1, ge=1, description="Page number"),
+    size: int = Query(10, ge=1, le=100, description="Page size"),
 ):
-    result = await db.execute(select(Item).filter(Item.user_id == user.id))
-    items = result.scalars().all()
-    return [ItemRead.model_validate(item) for item in items]
+    params = Params(page=page, size=size)
+    query = select(Item).filter(Item.user_id == user.id)
+    return await apaginate(db, query, params, transformer=transform_items)
 
 
 @router.post("/", response_model=ItemRead)

fastapi_backend/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "app"
-version = "0.0.4"
+version = "0.0.5"
 description = ""
 authors = [{ name = "Anderson Resende", email = "[email protected]" }]
 requires-python = ">=3.12,<3.13"
@@ -11,6 +11,7 @@ dependencies = [
     "fastapi-users[sqlalchemy]>=13.0.0,<14",
     "pydantic-settings>=2.5.2,<3",
     "fastapi-mail>=1.4.1,<2",
+    "fastapi-pagination==0.13.3"
 ]
 
 [dependency-groups]

fastapi_backend/requirements.txt

@@ -516,3 +516,4 @@ websockets==14.1 \
     --hash=sha256:bc6ccf7d54c02ae47a48ddf9414c54d48af9c01076a2e1023e3b486b6e72c707 \
     --hash=sha256:eb6d38971c800ff02e4a6afd791bbe3b923a9a57ca9aeab7314c21c84bf9ff05 \
     --hash=sha256:ed907449fe5e021933e46a3e65d651f641975a768d0649fee59f10c2985529ed
+fastapi-pagination==0.13.3

fastapi_backend/tests/routes/test_items.py

@@ -48,16 +48,31 @@ async def test_read_items(self, test_client, db_session, authenticated_user):
         for item_data in items_data:
             await db_session.execute(insert(Item).values(**item_data))
 
-        # Read items
+        await db_session.commit()  # Add commit to ensure items are saved
+
+        # Read items - test pagination response
         read_response = await test_client.get(
             "/items/", headers=authenticated_user["headers"]
         )
         assert read_response.status_code == status.HTTP_200_OK
-        items = read_response.json()
+        response_data = read_response.json()
+
+        # Check pagination structure
+        assert "items" in response_data
+        assert "total" in response_data
+        assert "page" in response_data
+        assert "size" in response_data
+
+        items = response_data["items"]
+
+        # Filter items created in this test (to avoid interference from other tests)
+        test_items = [
+            item for item in items if item["name"] in ["First Item", "Second Item"]
+        ]
 
-        assert len(items) == 2
-        assert any(item["name"] == "First Item" for item in items)
-        assert any(item["name"] == "Second Item" for item in items)
+        assert len(test_items) == 2
+        assert any(item["name"] == "First Item" for item in test_items)
+        assert any(item["name"] == "Second Item" for item in test_items)
 
     @pytest.mark.asyncio(loop_scope="function")
     async def test_delete_item(self, test_client, db_session, authenticated_user):