feat: Added health check endpoint

Author: GermanMT

app/config.py

@@ -4,6 +4,7 @@
 
 
 class Settings(BaseSettings):
+    DOCS_URL: str | None = None
     GATEWAY_ALLOWED_ORIGINS: str = ""
 
 

app/main.py

@@ -1,12 +1,14 @@
 from contextlib import asynccontextmanager
 
-from fastapi import FastAPI, Request
+from fastapi import FastAPI, Request, status
 from httpx import AsyncClient
 from starlette.middleware.cors import CORSMiddleware
+from starlette.responses import JSONResponse
 
 from app.config import settings
 from app.middleware import log_request_middleware
-from app.utils import build_merged_openapi, proxy_request
+from app.utils import build_merged_openapi, proxy_request, json_encoder
+from app.limiter import limiter
 
 
 @asynccontextmanager
@@ -30,8 +32,7 @@ async def lifespan(app: FastAPI):
             }
     yield
 
-
-app = FastAPI(title="Secure Chain Gateway", docs_url=None, lifespan=lifespan)
+app = FastAPI(title="Secure Chain Gateway", docs_url=settings.DOCS_URL, lifespan=lifespan)
 app.middleware("http")(log_request_middleware)
 app.add_middleware(
     CORSMiddleware,
@@ -42,13 +43,34 @@ async def lifespan(app: FastAPI):
 )
 
 
+@app.get(
+    "/health",
+    summary="Health Check",
+    description="Check the status of the API.",
+    response_description="API status.",
+    tags=["Secure Chain Gateway Health"]
+)
+@limiter.limit("25/minute")
+async def health_check(request: Request):
+    return JSONResponse(
+        status_code=status.HTTP_200_OK, content=json_encoder(
+            {
+                "code": "healthy",
+            }
+        )
+    )
+
+
 @app.api_route("/auth/{path:path}", methods=["GET", "POST", "PUT", "DELETE", "PATCH"])
+@limiter.limit("25/minute")
 async def proxy_auth(path: str, request: Request):
     url = f"http://securechain-auth:8000/{path}"
     return await proxy_request(url, request)
 
 
 @app.api_route("/depex/{path:path}", methods=["GET", "POST", "PUT", "DELETE", "PATCH"])
+@limiter.limit("25/minute")
 async def proxy_depex(path: str, request: Request):
     url = f"http://securechain-depex:8000/{path}"
     return await proxy_request(url, request)
+

app/utils/__init__.py

@@ -1,3 +1,4 @@
-from app.utils.openapi_merge import build_merged_openapi, proxy_request
+from .openapi_merge import build_merged_openapi, proxy_request
+from .json_encoder import json_encoder
 
-__all__ = ["build_merged_openapi", "proxy_request"]
+__all__ = ["build_merged_openapi", "proxy_request", "json_encoder"]

app/utils/json_encoder.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+from json import JSONEncoder, loads
+from typing import Any
+
+
+class JSONencoder(JSONEncoder):
+    def default(self, o: Any) -> Any:
+        if isinstance(o, datetime):
+            return str(o)
+        return JSONEncoder.default(self, o)
+
+
+def json_encoder(raw_response: dict[str, Any]) -> Any:
+    return loads(JSONencoder().encode(raw_response))