feat: hide open API in prod

Makefile

@@ -29,7 +29,7 @@ add-package: ## Installs a new package in the app. ex: make install package=XXX
 
 .PHONY: run
 run: ## Runs the app in production mode
-	poetry run fastapi run
+	OPENAPI_URL= poetry run fastapi run
 
 .PHONY: dev
 dev: ## Runs the app in development mode

main.py

@@ -5,17 +5,16 @@
 from fastapi import FastAPI
 from src.common import config
 from src.common.logger import setup_logging
+from src.common.settings import Settings
 from src.delivery.api.v1.health.health_router import health
 from src.delivery.api.v1.hello.hello_router import hello
 from time import sleep
 
 
-logger = logging.getLogger(__name__)
-
-
 @asynccontextmanager
 async def lifespan(_app: FastAPI) -> AsyncGenerator:
     setup_logging()
+    logger = logging.getLogger(__name__)
     logger.info("Starting FastAPI server...")
 
     yield
@@ -25,7 +24,14 @@ async def lifespan(_app: FastAPI) -> AsyncGenerator:
     logger.info("FastAPI server finished!")
 
 
-app = FastAPI(title=config.PROJECT_NAME, lifespan=lifespan)
+settings = Settings()
+
+app = FastAPI(
+    title=config.PROJECT_NAME,
+    description="This is the documentation of the FastAPI template project.",
+    lifespan=lifespan,
+    openapi_url=settings.openapi_url,
+)
 
 app.include_router(prefix=config.API_V1_PREFIX, router=health)
 app.include_router(prefix=config.API_V1_PREFIX, router=hello)

pyproject.toml

@@ -9,6 +9,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.12"
 fastapi = {extras = ["standard"], version = "^0.115.0"}
+pydantic-settings = "^2.5.2"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^8.3.3"

src/common/settings.py

@@ -0,0 +1,5 @@
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    openapi_url: str = "/openapi.json"