add fastapi-voyager

backend/main.py

@@ -10,6 +10,7 @@ import uvicorn
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi_pagination import add_pagination
+from fastapi_voyager import create_voyager
 from starlette.middleware.authentication import AuthenticationMiddleware
 from startup import main
 
@@ -93,7 +94,11 @@ if not IS_PYTEST_RUN and not DISABLE_CSRF_PROTECTION:
         CustomCSRFMiddleware,
         cookie_name="romm_csrftoken",
         secret=ROMM_AUTH_SECRET_KEY,
-        exempt_urls=[re.compile(r"^/api/token.*"), re.compile(r"^/ws")],
+        exempt_urls=[
+            re.compile(r"^/api/token.*"),
+            re.compile(r"^/ws"),
+            re.compile(r"^/api/voyager"),
+        ],
     )
 
 # Handles both basic and oauth authentication
@@ -135,6 +140,27 @@ app.include_router(gamelist.router, prefix="/api")
 
 app.mount("/ws", socket_handler.socket_app)
 
+app.mount(
+    "/api/voyager",
+    create_voyager(
+        app,
+        module_color={
+            "adapters": "blue",
+            "configs": "green",
+            "endpoints": "red",
+            "handler.auth": "yellow",
+            "handler.database": "cyan",
+            "handler.filesystem": "magenta",
+            "handler.metadata": "lightblue",
+            "models": "purple",
+            "tasks.manual": "orange",
+            "tasks.scheduled": "pink",
+            "utils": "brown",
+        },
+        swagger_url="/api/docs",
+    ),
+)
+
 add_pagination(app)
 
 

pyproject.toml

@@ -84,3 +84,6 @@ Source = "https://github.com/rommapp/romm"
 
 [tool.uv]
 package = false
+
+[dependency-groups]
+dev = ["fastapi-voyager>=0.11.8"]

uv.lock

@@ -6,6 +6,18 @@ resolution-markers = [
     "platform_python_implementation == 'PyPy'",
 ]
 
+[[package]]
+name = "aiodataloader"
+version = "0.4.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/bc/3b/405fe771e782054509f976db2a29c69bb6250be8bde16ac1fa93755070c6/aiodataloader-0.4.2.tar.gz", hash = "sha256:c92f6f2fb7ee13939ffd68274895aca44ccc0294a1275179bfb8af2b29b788e1", size = 13458, upload-time = "2025-02-17T14:51:43.336Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/ef/20/8700336be44dcccab78741f2513b1b1474ba4070134e8c2b5a50865f07bd/aiodataloader-0.4.2-py3-none-any.whl", hash = "sha256:3c9780867631326a2ae931c322fac5e2a2ad5a48bf7646e5250834630536ef57", size = 10994, upload-time = "2025-02-17T14:51:41.589Z" },
+]
+
 [[package]]
 name = "aiohappyeyeballs"
 version = "2.6.1"
@@ -508,6 +520,19 @@ sqlalchemy = [
     { name = "sqlalchemy" },
 ]
 
+[[package]]
+name = "fastapi-voyager"
+version = "0.11.8"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "fastapi" },
+    { name = "pydantic-resolve" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/c2/24/84943d29933fdbb797e5d6c19ac81e24b6754cf44937968e11aeac3ce9bf/fastapi_voyager-0.11.8.tar.gz", hash = "sha256:dd74b89e70ba5b01bbad3b3e8dd4d4be288705c81f04a61092ca18b976779a5e", size = 580976, upload-time = "2025-11-03T23:29:19.333Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/07/f1/7f5847a680fc3fc2287b1651d04e877e3905c59c22b6fe2a3de3b41a07d7/fastapi_voyager-0.11.8-py3-none-any.whl", hash = "sha256:bcc56c9fc7475ad34bdbdce8ba8aa83baf000ceb3f08371436fc091c3b078ba7", size = 529599, upload-time = "2025-11-03T23:29:17.478Z" },
+]
+
 [[package]]
 name = "frozenlist"
 version = "1.7.0"
@@ -1607,6 +1632,18 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/6f/9a/e73262f6c6656262b5fdd723ad90f518f579b7bc8622e43a942eec53c938/pydantic_core-2.33.2-cp313-cp313t-win_amd64.whl", hash = "sha256:c2fc0a768ef76c15ab9238afa6da7f69895bb5d1ee83aeea2e3509af4472d0b9", size = 1935777, upload-time = "2025-04-23T18:32:25.088Z" },
 ]
 
+[[package]]
+name = "pydantic-resolve"
+version = "1.13.5"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "aiodataloader" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/5a/b8/e4026796bd4a3f97255dfc6c61718aefd8e1d45a1180d39a09c60d0bf9a1/pydantic_resolve-1.13.5.tar.gz", hash = "sha256:862c75273f792ac6ef27b5117b844466ac142080a12b2f816c0b4ca08f0059c3", size = 26926, upload-time = "2025-10-23T02:51:07.447Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/f3/30/03b74616dff02fa7dbfc44e67b4d0ba7608230085e9658e4d3f0a50761b8/pydantic_resolve-1.13.5-py3-none-any.whl", hash = "sha256:5a7a46c9d42ce9cd3b2b90e7f6a9cd7cf277cfe10d82451644f8f224c3e9d753", size = 28238, upload-time = "2025-10-23T02:51:05.929Z" },
+]
+
 [[package]]
 name = "pydash"
 version = "7.0.7"
@@ -1955,6 +1992,11 @@ test = [
     { name = "pytest-recording" },
 ]
 
+[package.dev-dependencies]
+dev = [
+    { name = "fastapi-voyager" },
+]
+
 [package.metadata]
 requires-dist = [
     { name = "aiohttp", specifier = "~=3.12" },
@@ -2017,6 +2059,9 @@ requires-dist = [
 ]
 provides-extras = ["dev", "test"]
 
+[package.metadata.requires-dev]
+dev = [{ name = "fastapi-voyager", specifier = ">=0.11.8" }]
+
 [[package]]
 name = "rq"
 version = "2.4.0"