From babb09c6af0bd8355f758b48e5d401cf15434153 Mon Sep 17 00:00:00 2001 From: Ruslan Bel'kov Date: Mon, 12 Aug 2024 21:27:47 +0300 Subject: [PATCH] feat: add warning about fastapi params --- fastapi_swagger/main.py | 13 +++++++++++++ test/test_fastapi.py | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/fastapi_swagger/main.py b/fastapi_swagger/main.py index 489b4d1..139cb8f 100644 --- a/fastapi_swagger/main.py +++ b/fastapi_swagger/main.py @@ -1,3 +1,4 @@ +import warnings from importlib import resources from typing import Optional, Dict, Any @@ -34,6 +35,18 @@ def patch_fastapi( :param init_oauth: OAuth2 configuration :param oauth2_redirect_url: OAuth2 redirect URL """ + # docs_url=None, swagger_ui_oauth2_redirect_url=None should be set in FastAPI app definition + if getattr(app, "docs_url", None) is not None: + warnings.warn( + "`docs_url` is set in FastAPI app definition, please, set it to None", + UserWarning, + ) + if getattr(app, "swagger_ui_oauth2_redirect_url", None) is not None: + warnings.warn( + "`swagger_ui_oauth2_redirect_url` is set in FastAPI app definition, please, set it to None", + UserWarning, + ) + if redirect_from_root_to_docs: @app.get("/", include_in_schema=False) diff --git a/test/test_fastapi.py b/test/test_fastapi.py index 0711e4d..5cf33ae 100644 --- a/test/test_fastapi.py +++ b/test/test_fastapi.py @@ -4,7 +4,7 @@ def test_app(): - app = FastAPI(title="Test App") + app = FastAPI(title="Test App", docs_url=None, swagger_ui_oauth2_redirect_url=None) patch_fastapi(app, title="Test App") client = TestClient(app) response = client.get("/docs")