Skip to content

fix(server): print localhost Swagger URL #710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sarvesh1327 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(server): print localhost Swagger URL #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c322e92
fix(server): print localhost Swagger URL
sarvesh1327 Jun 12, 2026
e5bab03
Merge branch 'main' into fix/localhost-swagger-url
bhimrazy Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/litserve/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@
SHUTDOWN_API_KEY = os.environ.get("LIT_SHUTDOWN_API_KEY")
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")


def _display_host_for_url(host: str) -> str:
"""Return a browser-usable host for user-facing URLs."""
return "localhost" if host in {"0.0.0.0", "::"} else host


# FastAPI writes form files to disk over 1MB by default, which prevents serialization by multiprocessing
MultiPartParser.max_file_size = sys.maxsize
# renamed in PR: https://github.com/encode/starlette/pull/2780
Expand Down Expand Up @@ -1510,7 +1516,8 @@ def run(
)

if not self._disable_openapi_url:
print(f"Swagger UI is available at http://0.0.0.0:{port}/docs")
display_host = _display_host_for_url(host)
print(f"Swagger UI is available at http://{display_host}:{port}/docs")

if self._monitor_workers:
self._start_worker_monitoring(manager, uvicorn_workers)
Expand Down
10 changes: 9 additions & 1 deletion tests/unit/test_lit_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,14 @@ def test_server_terminate():
server._transport.close.assert_called()


def test_display_host_for_url_uses_browser_address():
from litserve.server import _display_host_for_url

assert _display_host_for_url("0.0.0.0") == "localhost"
assert _display_host_for_url("::") == "localhost"
assert _display_host_for_url("127.0.0.1") == "127.0.0.1"


@pytest.mark.parametrize(("disable_openapi_url", "should_print"), [(False, True), (True, False)])
@patch("builtins.print")
@patch("litserve.server.uvicorn")
Expand All @@ -356,7 +364,7 @@ def test_disable_openapi_url_print_message(mock_uvicorn, mock_print, mock_manage
server.run(port=8000)

if should_print:
mock_print.assert_called_with("Swagger UI is available at http://0.0.0.0:8000/docs")
mock_print.assert_called_with("Swagger UI is available at http://localhost:8000/docs")
else:
mock_print.assert_not_called()

Expand Down