Update the /docs route

src/main.py

@@ -11,6 +11,7 @@
 
 from fastapi import FastAPI
 
+from startup.add_documentation import add_documentation
 from startup.create_db import create_database
 from startup.config_cors import config_cors
 from startup import error_logger
@@ -22,11 +23,14 @@
 error_logger.init_logger()
 
 app = FastAPI(
+    docs_url=None, redoc_url=None,
     title="NavCraft API",
     version="1.0.0",
-    description="An API tool to help pilots craft the perfect navigation flight plans. It uses aircraft performance data, and Canadian aviation rules, regulations and definitions, to produce flight plans that include: \n \n - navigation logs, \n \n - weight and balance charts and calculations, \n \n - fuel calculations, \n \n - takeoff and landing distances."
+    swagger_favicon_url="../public/logo.png",
+    description="Helping pilots craft the perfect navigation flight plans. NavCraft API uses aircraft performance data, and Canadian aviation rules, regulations and definitions, to produce VFR flight plans that include: \n \n - navigation logs, \n \n - weight and balance graphs and calculations, \n \n - fuel calculations, \n \n - takeoff and landing distances."
 )
 
+add_documentation(app)
 create_database()
 migrate_db()
 config_cors(app)

src/startup/add_documentation.py

@@ -0,0 +1,44 @@
+"""
+Documentation startup module
+
+Module asigns adds the /docs route to the API, to display the APIS's documentation.
+
+Usage: 
+- Import the add_documentation function, and pass the FastAPI app as a parameter.
+
+"""
+
+from fastapi import FastAPI, status, HTTPException, Request
+from fastapi.openapi.docs import get_swagger_ui_html
+from fastapi.responses import HTMLResponse
+from fastapi.staticfiles import StaticFiles
+
+
+def add_documentation(app: FastAPI):
+    """
+    This function adds the API /docs route
+    """
+    app.mount("/static", StaticFiles(directory="static"), name="static")
+
+    @app.get("/docs", include_in_schema=False)
+    def overridden_swagger(req: Request) -> HTMLResponse:
+        root_path = req.scope.get("root_path", "").rstrip("/")
+        openapi_url = root_path + app.openapi_url
+        oauth2_redirect_url = app.swagger_ui_oauth2_redirect_url
+        if oauth2_redirect_url:
+            oauth2_redirect_url = root_path + oauth2_redirect_url
+        return get_swagger_ui_html(
+            openapi_url=openapi_url,
+            title=app.title + " | Docs",
+            oauth2_redirect_url=oauth2_redirect_url,
+            init_oauth=app.swagger_ui_init_oauth,
+            swagger_favicon_url="/static/logo.png",
+            swagger_ui_parameters=app.swagger_ui_parameters,
+        )
+
+    @app.get("/redoc", include_in_schema=False)
+    def overridden_redoc():
+        raise HTTPException(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            detail="Not Found"
+        )

src/startup/migrate_db.py

@@ -23,7 +23,7 @@
 from utils.db import engine, Session
 from functions.data_processing import clean_string
 
-_PATH = "static_data/"
+_PATH = "static/"
 
 
 def _set_charracter_set() -> None: