refactor: explore rethinking client-side fetching

backend/api/sample.py

@@ -0,0 +1,37 @@
+"""Sample API to show off OpenAPI integration"""
+
+from fastapi import APIRouter
+from ..models.sample import (
+    GetSampleItemsResponse,
+    GetSampleItemsResponse_Item,
+    GetSampleItemResponse,
+    CreateSampleItemRequest,
+    CreateSampleItemResponse,
+)
+
+api = APIRouter(prefix="/api/sample")
+tag = "Sample Endpoint"
+openapi_tags = {
+    "name": tag,
+    "description": "Sample API endpoint for showing off OpenAPI integration.",
+}
+
+
+@api.get("", tags=[tag])
+def get_all() -> GetSampleItemsResponse:
+    return GetSampleItemsResponse(
+        items=[
+            GetSampleItemsResponse_Item(id=1, name="One", price=99.99),
+            GetSampleItemsResponse_Item(id=2, name="Two", price=199.99),
+        ]
+    )
+
+
+@api.get("/{id}", tags=[tag])
+def get(id: int) -> GetSampleItemResponse:
+    return GetSampleItemResponse(id=1, name="One", price=99.99)
+
+
+@api.post("", tags=[tag])
+def create(_: CreateSampleItemRequest) -> CreateSampleItemResponse:
+    return CreateSampleItemResponse(id=1)

backend/main.py

@@ -21,6 +21,7 @@
     article,
     signage,
     websocket,
+    sample,
 )
 from .api.coworking import status, reservation, ambassador, operating_hours
 from .api.academics import section_member, term, course, section, my_courses, hiring
@@ -71,6 +72,7 @@
         admin_facts.openapi_tags,
         article.openapi_tags,
         signage.openapi_tags,
+        sample.openapi_tags,
     ],
 )
 
@@ -105,6 +107,7 @@
     article,
     signage,
     websocket,
+    sample,
 ]
 
 for feature_api in feature_apis:

backend/models/sample.py

@@ -0,0 +1,28 @@
+"""API validation models for the sample endpoint"""
+
+from pydantic import BaseModel
+
+
+class GetSampleItemsResponse_Item(BaseModel):
+    id: int
+    name: str
+    price: float
+
+
+class GetSampleItemsResponse(BaseModel):
+    items: list[GetSampleItemsResponse_Item]
+
+
+class GetSampleItemResponse(BaseModel):
+    id: int
+    name: str
+    price: float
+
+
+class CreateSampleItemRequest(BaseModel):
+    name: str
+    starting_price: float
+
+
+class CreateSampleItemResponse(BaseModel):
+    id: int