feat: fetch app docs_url

Author: chipytux

src/fastapi_cli/cli.py

@@ -1,6 +1,7 @@
+import importlib
 from logging import getLogger
 from pathlib import Path
-from typing import Any, Union
+from typing import Any, Final, Union
 
 import typer
 import uvicorn
@@ -15,6 +16,8 @@
 from . import __version__
 from .logging import setup_logging
 
+DEFAULT_DOCS_URL: Final[str] = "/docs"
+
 app = typer.Typer(rich_markup_mode="rich")
 
 setup_logging()
@@ -45,6 +48,13 @@ def callback(
     """
 
 
+def _get_docs_url(uvicorn_path: str) -> str:
+    module_path, app_name = uvicorn_path.split(sep=":")
+    module = importlib.import_module(module_path)
+    app = getattr(module, app_name)
+    return app.docs_url or DEFAULT_DOCS_URL
+
+
 def _run(
     path: Union[Path, None] = None,
     *,
@@ -62,7 +72,13 @@ def _run(
     except FastAPICLIException as e:
         logger.error(str(e))
         raise typer.Exit(code=1) from None
-    serving_str = f"[dim]Serving at:[/dim] [link]http://{host}:{port}[/link]\n\n[dim]API docs:[/dim] [link]http://{host}:{port}/docs[/link]"
+
+    docs_url = _get_docs_url(use_uvicorn_app)
+
+    serving_str = (
+        f"[dim]Serving at:[/dim] [link]http://{host}:{port}[/link]\n\n[dim]"
+        f"API docs:[/dim] [link]http://{host}:{port}{docs_url}[/link]"
+    )
 
     if command == "dev":
         panel = Panel(

tests/assets/with_docs_url_set.py

@@ -0,0 +1,8 @@
+from fastapi import FastAPI
+
+app = FastAPI(docs_url="/any-other-path")
+
+
+@app.get("/")
+def api_root():
+    return {"message": "any message"}

tests/assets/without_docs_url_set.py

@@ -0,0 +1,8 @@
+from fastapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/")
+def api_root():
+    return {"message": "any message"}

tests/test_cli.py

@@ -4,7 +4,7 @@
 from unittest.mock import patch
 
 import uvicorn
-from fastapi_cli.cli import app
+from fastapi_cli.cli import DEFAULT_DOCS_URL, app
 from typer.testing import CliRunner
 
 from tests.utils import changing_dir
@@ -221,3 +221,115 @@ def test_script() -> None:
         encoding="utf-8",
     )
     assert "Usage" in result.stdout
+
+
+def test_dev_and_fastapi_app_with_docs_url_set_should_show_correctly_url_in_stdout() -> (
+    None
+):
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["dev", "with_docs_url_set.py"])
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "with_docs_url_set:app",
+                "host": "127.0.0.1",
+                "port": 8000,
+                "reload": True,
+                "workers": None,
+                "root_path": "",
+                "proxy_headers": True,
+            }
+        assert "Using import string with_docs_url_set:app" in result.output
+        assert (
+            "╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://127.0.0.1:8000" in result.output
+        assert "│  API docs: http://127.0.0.1:8000/any-other-path" in result.output
+        assert "│  Running in development mode, for production use:" in result.output
+        assert "│  fastapi run" in result.output
+
+
+def test_dev_and_fastapi_app_without_docs_url_set_should_show_default_url_in_stdout() -> (
+    None
+):
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["dev", "without_docs_url_set.py"])
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "without_docs_url_set:app",
+                "host": "127.0.0.1",
+                "port": 8000,
+                "reload": True,
+                "workers": None,
+                "root_path": "",
+                "proxy_headers": True,
+            }
+        assert "Using import string without_docs_url_set:app" in result.output
+        assert (
+            "╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://127.0.0.1:8000" in result.output
+        assert f"│  API docs: http://127.0.0.1:8000{DEFAULT_DOCS_URL}" in result.output
+        assert "│  Running in development mode, for production use:" in result.output
+        assert "│  fastapi run" in result.output
+
+
+def test_run_and_fastapi_app_with_docs_url_set_should_show_correctly_url_in_stdout() -> (
+    None
+):
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["run", "with_docs_url_set.py"])
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "with_docs_url_set:app",
+                "host": "0.0.0.0",
+                "port": 8000,
+                "reload": False,
+                "workers": None,
+                "root_path": "",
+                "proxy_headers": True,
+            }
+        assert "Using import string with_docs_url_set:app" in result.output
+        assert (
+            "╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://0.0.0.0:8000" in result.output
+        assert "│  API docs: http://0.0.0.0:8000/any-other-path" in result.output
+        assert "│  Running in production mode, for development use:" in result.output
+        assert "│  fastapi dev" in result.output
+
+
+def test_run_and_fastapi_app_without_docs_url_set_should_show_default_url_in_stdout() -> (
+    None
+):
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["run", "without_docs_url_set.py"])
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "without_docs_url_set:app",
+                "host": "0.0.0.0",
+                "port": 8000,
+                "reload": False,
+                "workers": None,
+                "root_path": "",
+                "proxy_headers": True,
+            }
+        assert "Using import string without_docs_url_set:app" in result.output
+        assert (
+            "╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
+        )
+        assert "│  Serving at: http://0.0.0.0:8000" in result.output
+        assert f"│  API docs: http://0.0.0.0:8000{DEFAULT_DOCS_URL}" in result.output
+        assert "│  Running in production mode, for development use:" in result.output
+        assert "│  fastapi dev" in result.output