refactor: change the variable name to X_API_KEY for readability

Author: torrid-fish

config/settings.py

@@ -13,5 +13,5 @@
 ALLOW_ORIGINS: list[str] = os.getenv("ALLOW_ORIGINS", "").split(",")
 assert ALLOW_ORIGINS, "ALLOW_ORIGINS environment variable is not set"
 
-BUILD_API_KEY: str = os.getenv("BUILD_API_KEY", "")
-assert BUILD_API_KEY, "BUILD_API_KEY environment variable is not set"
+X_API_KEY: str = os.getenv("X_API_KEY", "")
+assert X_API_KEY, "X_API_KEY environment variable is not set"

main.py

@@ -23,7 +23,7 @@
 from starlette.status import HTTP_403_FORBIDDEN
 
 from api import accent_marker, dict_query, furigana_marker, sentence_query, usage_query
-from config.settings import ALLOW_ORIGINS, ALLOWED_HOSTS, BUILD_API_KEY
+from config.settings import ALLOW_ORIGINS, ALLOWED_HOSTS, X_API_KEY
 
 
 @asynccontextmanager
@@ -74,7 +74,7 @@ async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
 # API Key Header for build API key authentication
 api_key_header = APIKeyHeader(name="X-API-KEY", auto_error=False)
 async def get_api_key(api_key: str = Security(api_key_header)) -> None:
-    if api_key != BUILD_API_KEY:
+    if api_key != X_API_KEY:
         raise HTTPException(
             status_code=HTTP_403_FORBIDDEN, detail="Could not validate credentials"
         )