Respect root_path in URLs

Author: YuriiMotov

src/fastapi_cli/cli.py

@@ -12,6 +12,7 @@
     get_docs_urls,
     get_import_data,
     get_import_data_from_import_string,
+    get_root_path,
 )
 from fastapi_cli.exceptions import FastAPICLIException
 
@@ -196,6 +197,11 @@ def _run(
         docs_urls = get_docs_urls(import_data)
 
         url = f"http://{host}:{port}"
+
+        use_root_path = root_path or get_root_path(import_data)
+        if use_root_path:
+            url += use_root_path
+
         docs_url = ""
 
         if docs_urls.openapi_url and (docs_urls.docs_url or docs_urls.redoc_url):

src/fastapi_cli/discover.py

@@ -180,3 +180,15 @@ def get_docs_urls(import_data: ImportData) -> DocsURLs:
         docs_url=app.docs_url,
         redoc_url=app.redoc_url,
     )
+
+
+def get_root_path(import_data: ImportData) -> str:
+    module = importlib.import_module(import_data.module_data.module_import_str)
+    app_name = import_data.app_name
+    app = getattr(module, app_name)
+
+    # Just for type checking, it's already checked in get_app_name
+    assert FastAPI is not None
+    assert isinstance(app, FastAPI)
+
+    return app.root_path

tests/assets/single_file_docs.py

@@ -75,3 +75,25 @@ def custom_docs_root():
 @custom_redoc.get("/")
 def custom_redoc_root():
     return {"message": "single file custom_redoc"}
+
+
+# App 8: Swagger docs enabled, root_path set to "/api". ReDoc disabled.
+# ------------------------------------------------------------------------------------
+
+docs_root_path = FastAPI(redoc_url=None, root_path="/api")
+
+
+@docs_root_path.get("/")
+def docs_root_path_root():
+    return {"message": "single file docs_root_path"}
+
+
+# App 9: ReDoc enabled, root_path set to "/api". Swagger docs disabled.
+# ------------------------------------------------------------------------------------
+
+redoc_root_path = FastAPI(docs_url=None, root_path="/api")
+
+
+@redoc_root_path.get("/")
+def redoc_root_path_root():
+    return {"message": "single file redoc_root_path"}

tests/test_cli.py

@@ -133,8 +133,8 @@ def test_dev_args() -> None:
             }
         assert "Using import string: single_file_app:api" in result.output
         assert "Starting development server 🚀" in result.output
-        assert "Server started at http://192.168.0.2:8080" in result.output
-        assert "Documentation at http://192.168.0.2:8080/docs" in result.output
+        assert "Server started at http://192.168.0.2:8080/api" in result.output
+        assert "Documentation at http://192.168.0.2:8080/api/docs" in result.output
         assert (
             "Running in development mode, for production use: fastapi run"
             in result.output
@@ -323,8 +323,8 @@ def test_run_args() -> None:
 
         assert "Using import string: single_file_app:api" in result.output
         assert "Starting production server 🚀" in result.output
-        assert "Server started at http://192.168.0.2:8080" in result.output
-        assert "Documentation at http://192.168.0.2:8080/docs" in result.output
+        assert "Server started at http://192.168.0.2:8080/api" in result.output
+        assert "Documentation at http://192.168.0.2:8080/api/docs" in result.output
         assert (
             "Running in development mode, for production use: fastapi run"
             not in result.output
@@ -475,6 +475,58 @@ def test_docs_urls_custom_redoc() -> None:
         assert "http://127.0.0.1:8000/custom-redoc-url" in result.output
 
 
+@pytest.mark.parametrize(
+    ("app_name", "expected_url"),
+    [
+        ("only_docs", "http://127.0.0.1:8000/api/docs"),
+        ("only_redoc", "http://127.0.0.1:8000/api/redoc"),
+    ],
+)
+def test_docs_urls_root_path_option(app_name: str, expected_url: str) -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(
+                app,
+                [
+                    "dev",
+                    "single_file_docs.py",
+                    "--app",
+                    app_name,
+                    "--root-path",
+                    "/api",
+                ],
+            )
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+
+        assert expected_url in result.output
+
+
+@pytest.mark.parametrize(
+    ("app_name", "expected_url"),
+    [
+        ("docs_root_path", "http://127.0.0.1:8000/api/docs"),
+        ("redoc_root_path", "http://127.0.0.1:8000/api/redoc"),
+    ],
+)
+def test_docs_urls_root_path_param(app_name: str, expected_url: str) -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(
+                app,
+                [
+                    "dev",
+                    "single_file_docs.py",
+                    "--app",
+                    app_name,
+                ],
+            )
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+
+        assert expected_url in result.output
+
+
 def test_run_error() -> None:
     with changing_dir(assets_path):
         result = runner.invoke(app, ["run", "non_existing_file.py"])