Added health route to backend

backend/health/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class HealthConfig(AppConfig):
+    name = "health"

backend/health/urls.py

@@ -0,0 +1,10 @@
+from django.urls import path
+
+from health.views import HealthView
+
+
+app_name = "health"
+
+urlpatterns = [
+    path("health/", HealthView.as_view(), name="health"),
+]

backend/health/views.py

@@ -0,0 +1,25 @@
+from http import HTTPStatus
+
+from django.http import JsonResponse
+from django.views.generic import View
+
+
+class HealthView(View):
+    def get(self, request):
+        """
+        Health check endpoint to confirm the backend is running.
+        ---
+        summary: Health Check
+        responses:
+            "200":
+                content:
+                    application/json:
+                        schema:
+                            type: object
+                            properties:
+                                message:
+                                    type: string
+                                    enum: ["OK"]
+        ---
+        """
+        return JsonResponse({"message": "OK"}, status=HTTPStatus.OK)

backend/pennmobile/settings/base.py

@@ -54,6 +54,7 @@
     "options.apps.OptionsConfig",
     "sublet",
     "phonenumber_field",
+    "health",
 ]
 
 MIDDLEWARE = [

backend/pennmobile/urls.py

@@ -28,6 +28,7 @@
     path("penndata/", include("penndata.urls")),
     path("sublet/", include("sublet.urls")),
     path("wrapped/", include("wrapped.urls")),
+    path("", include("health.urls")),
 ]
 
 urlpatterns = [

backend/tests/health/test_route.py

@@ -0,0 +1,8 @@
+from django.test import TestCase
+
+
+class HealthTestCase(TestCase):
+    def test_health(self):
+        resp = self.client.get("/health/")
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.json(), {"message": "OK"})