Merge pull request #31 from ks6088ts-labs/copilot/fix-30

Refactor router configuration to use explicit prefix, tags, and responses in app.py

Author: ks6088ts

.env.template

@@ -23,8 +23,8 @@ AZURE_AI_FOUNDRY_PROJECT_ENDPOINT="https://xxx.services.ai.azure.com/api/project
 AZURE_AI_FOUNDRY_API_KEY="<YOUR_API_KEY>"
 
 # Chats WebSocket
-# Azure Container Apps: `wss://yourcontainerapps.japaneast.azurecontainerapps.io`
-CHATS_WEBSOCKET_URL="ws://localhost:8000"
+# Azure Container Apps: `wss://yourcontainerapps.japaneast.azurecontainerapps.io/chats`
+CHATS_WEBSOCKET_URL="ws://localhost:8000/chats"
 
 # Microsoft Graph Sites
 MICROSOFT_GRAPH_TENANT_ID="<YOUR_TENANT_ID>"

template_fastapi/app.py

@@ -11,7 +11,7 @@
 from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
 from opentelemetry.trace import Span
 
-from template_fastapi.routers import agents, chats, demos, files, foodies, games, items, speeches
+from template_fastapi.routers import agents, chats, demos, files, foodies, items, speeches
 
 app = FastAPI()
 
@@ -36,11 +36,54 @@ def server_request_hook(span: Span, scope: dict):
     FastAPIInstrumentor.instrument_app(app)
 
 # Include routers
-app.include_router(items.router)
-app.include_router(demos.router)
-app.include_router(games.router)
-app.include_router(foodies.router)
-app.include_router(files.router)
-app.include_router(speeches.router)
-app.include_router(chats.router)
-app.include_router(agents.router)
+# Routers configuration list
+routersConfig = [
+    {
+        "router": agents.router,
+        "prefix": "/agents",
+        "tags": ["agents"],
+    },
+    {
+        "router": chats.router,
+        "prefix": "/chats",
+        "tags": ["chats"],
+    },
+    {
+        "router": demos.router,
+        "prefix": "/demos",
+        "tags": ["demos"],
+    },
+    {
+        "router": files.router,
+        "prefix": "/files",
+        "tags": ["files"],
+    },
+    {
+        "router": foodies.router,
+        "prefix": "/foodies",
+        "tags": ["foodies"],
+    },
+    {
+        "router": items.router,
+        "prefix": "/items",
+        "tags": ["items"],
+    },
+    {
+        "router": speeches.router,
+        "prefix": "/speeches",
+        "tags": ["speeches"],
+    },
+]
+
+# Include routers using a loop
+for routerConfig in routersConfig:
+    app.include_router(
+        router=routerConfig["router"],
+        prefix=routerConfig["prefix"],
+        tags=routerConfig["tags"],
+        responses={
+            404: {
+                "description": "Not found",
+            },
+        },
+    )

template_fastapi/routers/agents/__init__.py

@@ -0,0 +1 @@
+from .core import router  # noqa: F401

template_fastapi/routers/agents.py renamed to template_fastapi/routers/agents/azure_ai_foundry.py

@@ -17,9 +17,8 @@
 
 
 @router.post(
-    "/agents/",
+    "/",
     response_model=AgentResponse,
-    tags=["agents"],
     operation_id="create_agent",
 )
 async def create_agent(request: AgentRequest) -> AgentResponse:
@@ -33,9 +32,8 @@ async def create_agent(request: AgentRequest) -> AgentResponse:
 
 
 @router.get(
-    "/agents/{agent_id}",
+    "/{agent_id}",
     response_model=AgentResponse,
-    tags=["agents"],
     operation_id="get_agent",
 )
 async def get_agent(agent_id: str) -> AgentResponse:
@@ -49,9 +47,8 @@ async def get_agent(agent_id: str) -> AgentResponse:
 
 
 @router.get(
-    "/agents/",
+    "/",
     response_model=AgentListResponse,
-    tags=["agents"],
     operation_id="list_agents",
 )
 async def list_agents(
@@ -67,8 +64,7 @@ async def list_agents(
 
 
 @router.delete(
-    "/agents/{agent_id}",
-    tags=["agents"],
+    "/{agent_id}",
     operation_id="delete_agent",
 )
 async def delete_agent(agent_id: str) -> dict:
@@ -86,9 +82,8 @@ async def delete_agent(agent_id: str) -> dict:
 
 
 @router.post(
-    "/agents/{agent_id}/chat",
+    "/{agent_id}/chat",
     response_model=ChatResponse,
-    tags=["agents"],
     operation_id="chat_with_agent",
 )
 async def chat_with_agent(agent_id: str, request: ChatRequest) -> ChatResponse:
@@ -102,9 +97,8 @@ async def chat_with_agent(agent_id: str, request: ChatRequest) -> ChatResponse:
 
 
 @router.post(
-    "/agents/threads/",
+    "/threads/",
     response_model=ThreadResponse,
-    tags=["agents"],
     operation_id="create_thread",
 )
 async def create_thread(request: ThreadRequest) -> ThreadResponse:
@@ -118,9 +112,8 @@ async def create_thread(request: ThreadRequest) -> ThreadResponse:
 
 
 @router.get(
-    "/agents/threads/{thread_id}",
+    "/threads/{thread_id}",
     response_model=ThreadResponse,
-    tags=["agents"],
     operation_id="get_thread",
 )
 async def get_thread(thread_id: str) -> ThreadResponse:
@@ -134,8 +127,7 @@ async def get_thread(thread_id: str) -> ThreadResponse:
 
 
 @router.delete(
-    "/agents/threads/{thread_id}",
-    tags=["agents"],
+    "/threads/{thread_id}",
     operation_id="delete_thread",
 )
 async def delete_thread(thread_id: str) -> dict:
@@ -153,9 +145,8 @@ async def delete_thread(thread_id: str) -> dict:
 
 
 @router.get(
-    "/agents/threads/",
+    "/threads/",
     response_model=ThreadListResponse,
-    tags=["agents"],
     operation_id="list_threads",
 )
 async def list_threads(

template_fastapi/routers/agents/core.py

@@ -0,0 +1,15 @@
+from fastapi import APIRouter
+
+from template_fastapi.routers.agents.azure_ai_foundry import router as azure_ai_foundry_router
+
+router = APIRouter()
+
+router.include_router(
+    router=azure_ai_foundry_router,
+    prefix="/azure-ai-foundry",
+    responses={
+        404: {
+            "description": "Not found",
+        },
+    },
+)

template_fastapi/routers/chats.py

@@ -10,8 +10,7 @@
 
 
 @router.get(
-    "/chats/",
-    tags=["chats"],
+    "/",
 )
 async def get(request: Request):
     """Get the chat page with configurable WebSocket URL."""

template_fastapi/routers/demos.py

@@ -3,14 +3,15 @@
 
 from fastapi import APIRouter, HTTPException
 
-from template_fastapi.opentelemetry import get_tracer
+from template_fastapi.opentelemetry import get_meter, get_tracer
 
 tracer = get_tracer(__name__)
+meter = get_meter(__name__)
 router = APIRouter()
 
 
 @tracer.start_as_current_span("flaky_exception")
-@router.get("/flaky/exception", tags=["flaky"], operation_id="flaky_exception")
+@router.get("/flaky/exception", operation_id="flaky_exception")
 async def flaky_exception():
     """
     A flaky endpoint that always raises an exception.
@@ -21,7 +22,7 @@ async def flaky_exception():
     )
 
 
-@router.get("/flaky/{failure_rate}", tags=["flaky"], operation_id="flaky")
+@router.get("/flaky/{failure_rate}", operation_id="flaky")
 async def flaky(failure_rate: int):
     """
     A flaky endpoint that simulates a failure based on the provided failure rate.
@@ -45,7 +46,7 @@ async def flaky(failure_rate: int):
     }
 
 
-@router.get("/heavy_sync/{sleep_ms}", tags=["heavy"], operation_id="heavy_sync_with_sleep")
+@router.get("/heavy_sync/{sleep_ms}", operation_id="heavy_sync_with_sleep")
 async def heavy_sync_with_sleep(sleep_ms: int):
     """
     A heavy synchronous endpoint that sleeps for the specified number of milliseconds.
@@ -66,3 +67,20 @@ async def heavy_sync_with_sleep(sleep_ms: int):
     return {
         "message": f"Slept for {sleep_ms} milliseconds",
     }
+
+
+roll_counter = meter.create_counter(
+    "dice.rolls",
+    description="The number of rolls by roll value",
+)
+
+
+@router.get("/roll_dice", operation_id="roll_dice")
+async def roll_dice():
+    """
+    Simulate rolling a dice and record the roll in the meter.
+    """
+    with tracer.start_as_current_span("roll_dice"):
+        roll = random.randint(1, 6)
+        roll_counter.add(1, {"roll.value": str(roll)})
+    return roll

template_fastapi/routers/files.py

@@ -11,9 +11,8 @@
 
 
 @router.get(
-    "/files/",
+    "/",
     response_model=list[FileModel],
-    tags=["files"],
     operation_id="list_files",
 )
 async def list_files(prefix: str | None = None) -> list[FileModel]:
@@ -27,9 +26,8 @@ async def list_files(prefix: str | None = None) -> list[FileModel]:
 
 
 @router.post(
-    "/files/upload",
+    "/upload",
     response_model=FileModel,
-    tags=["files"],
     operation_id="upload_file",
 )
 async def upload_file(file: UploadFile = File(...)) -> FileModel:
@@ -44,9 +42,8 @@ async def upload_file(file: UploadFile = File(...)) -> FileModel:
 
 
 @router.post(
-    "/files/upload-multiple",
+    "/upload-multiple",
     response_model=list[FileModel],
-    tags=["files"],
     operation_id="upload_multiple_files",
 )
 async def upload_multiple_files(files: list[UploadFile] = File(...)) -> list[FileModel]:
@@ -65,8 +62,7 @@ async def upload_multiple_files(files: list[UploadFile] = File(...)) -> list[Fil
 
 
 @router.get(
-    "/files/{file_name}",
-    tags=["files"],
+    "/{file_name}",
     operation_id="download_file",
 )
 async def download_file(file_name: str):
@@ -89,9 +85,8 @@ async def download_file(file_name: str):
 
 
 @router.get(
-    "/files/{file_name}/info",
+    "/{file_name}/info",
     response_model=FileModel,
-    tags=["files"],
     operation_id="get_file_info",
 )
 async def get_file_info(file_name: str) -> FileModel:
@@ -107,8 +102,7 @@ async def get_file_info(file_name: str) -> FileModel:
 
 
 @router.delete(
-    "/files/{file_name}",
-    tags=["files"],
+    "/{file_name}",
     operation_id="delete_file",
 )
 async def delete_file(file_name: str) -> dict:
@@ -125,8 +119,7 @@ async def delete_file(file_name: str) -> dict:
 
 
 @router.delete(
-    "/files/",
-    tags=["files"],
+    "/",
     operation_id="delete_multiple_files",
 )
 async def delete_multiple_files(file_names: list[str]) -> dict: