\#6 Apply api versioning and enhance folder structure

IbraheemTuffaha · Jul 20, 2024 · 1323452 · 1323452
1 parent 2d95b16
commit 1323452
Show file tree

Hide file tree

Showing 14 changed files with 37 additions and 31 deletions.
diff --git a/app/main.py b/app/main.py
@@ -1,11 +1,11 @@
 from fastapi import FastAPI
 
-from app.routers import dummy
+from app.v1.routers import router as v1_router
 
 
 app = FastAPI()
 
-app.include_router(dummy.router)
+app.include_router(v1_router)
 
 
 @app.get("/ping")

diff --git a/app/requests/__init__.py b/app/requests/__init__.py
diff --git a/app/requests/capitalize_request.py b/app/requests/capitalize_request.py
diff --git a/app/responses/__init__.py b/app/responses/__init__.py
diff --git a/app/responses/capitalize_response.py b/app/responses/capitalize_response.py
diff --git a/app/routers/dummy.py b/app/routers/dummy.py
diff --git a/app/v1/routers/__init__.py b/app/v1/routers/__init__.py
@@ -0,0 +1,4 @@
+from .base import router
+
+
+__all__ = ("router",)
diff --git a/app/v1/routers/base.py b/app/v1/routers/base.py
@@ -0,0 +1,7 @@
+from fastapi import APIRouter
+
+from .dummy import router as dummy_router
+
+
+router = APIRouter(prefix="/v1")
+router.include_router(dummy_router, prefix="/dummy", tags=["Dummy"])
diff --git a/app/v1/routers/dummy.py b/app/v1/routers/dummy.py
@@ -0,0 +1,11 @@
+from fastapi import APIRouter
+
+from app.v1.serializers import dummy as dummy_serializer
+
+
+router = APIRouter()
+
+
+@router.post("/capitalize", response_model=dummy_serializer.CapitalizeOut)
+async def capitalize(request: dummy_serializer.CapitalizeIn) -> dict[str, str]:
+    return {"text": request.text.upper()}
diff --git a/app/v1/serializers/dummy.py b/app/v1/serializers/dummy.py
@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+
+class BaseCapitalize(BaseModel):
+    text: str
+
+
+class CapitalizeIn(BaseCapitalize): ...
+
+
+class CapitalizeOut(BaseCapitalize): ...
diff --git a/tests/routers/__init__.py b/tests/routers/__init__.py
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -1,5 +1,6 @@
 from fastapi.testclient import TestClient
 
+
 def test_ping_endpoint(client: TestClient) -> None:
     response = client.get("/ping")
     assert response.status_code == 200

diff --git a/app/routers/__init__.py → tests/v1/routers/__init__.py b/app/routers/__init__.py → tests/v1/routers/__init__.py
diff --git a/tests/routers/test_dummy.py → tests/v1/routers/test_dummy.py b/tests/routers/test_dummy.py → tests/v1/routers/test_dummy.py
@@ -2,6 +2,6 @@
 
 
 def test_capitalize_endpoint(client: TestClient) -> None:
-    response = client.post("/dummy/capitalize", json={"text": "hello"})
+    response = client.post("/v1/dummy/capitalize", json={"text": "hello"})
     assert response.status_code == 200
     assert response.json() == {"text": "HELLO"}