From de5556dc874a888b8716132a02ba40c7b1733aba Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Sun, 6 Mar 2022 13:05:47 -0300 Subject: [PATCH 01/10] Add test --- tests/test_custom_openapi_subapp.py | 39 +++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 tests/test_custom_openapi_subapp.py diff --git a/tests/test_custom_openapi_subapp.py b/tests/test_custom_openapi_subapp.py new file mode 100644 index 000000000..50abcd3fa --- /dev/null +++ b/tests/test_custom_openapi_subapp.py @@ -0,0 +1,39 @@ +from fastapi import FastAPI +from fastapi.openapi.utils import get_openapi +from fastapi.testclient import TestClient + +swagger_ui_oauth2_redirect_url = "/docs/redirect" + +app = FastAPI() +sub_app = FastAPI( + docs_url=None, + redoc_url=None, + openapi_url=None, + ) + +@sub_app.get("/items/") +async def read_items(): + return {"id": "foo"} + +@sub_app.get("/openapi.json") +async def openapi(): + return get_openapi( + title="Custom OpenAPI", + version="0.1", + routes=sub_app.routes, + prefix="/sub_app", + ) + +app.mount("/sub_app", sub_app) + + +client = TestClient(app) + + +def test_sub_app_open_api(): + response = client.get("/sub_app/openapi.json") + assert response.status_code == 200, response.json() + assert response.headers["content-type"] == "application/json" + paths = list(response.json()["paths"].keys()) + assert paths == [ + "/sub_app/items/", "/sub_app/openapi.json",] From c71016a19b13d0550736ae5ce3a18cd2c5a2f7c6 Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Sun, 6 Mar 2022 13:06:15 -0300 Subject: [PATCH 02/10] Add prefix parameter for get_openapi function --- fastapi/openapi/utils.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index 58a748d04..46b685198 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -393,6 +393,7 @@ def get_openapi( terms_of_service: Optional[str] = None, contact: Optional[Dict[str, Union[str, Any]]] = None, license_info: Optional[Dict[str, Union[str, Any]]] = None, + prefix: Optional[str] = None, ) -> Dict[str, Any]: info: Dict[str, Any] = {"title": title, "version": version} if description: @@ -421,6 +422,8 @@ def get_openapi( ) if result: path, security_schemes, path_definitions = result + if prefix: + route.path_format= prefix + route.path_format if path: paths.setdefault(route.path_format, {}).update(path) if security_schemes: From 54b734e01532199c20ff5990f52ea23133ea630f Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Sun, 6 Mar 2022 13:14:24 -0300 Subject: [PATCH 03/10] Update test --- tests/test_custom_openapi_subapp.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/tests/test_custom_openapi_subapp.py b/tests/test_custom_openapi_subapp.py index 50abcd3fa..b0d96710f 100644 --- a/tests/test_custom_openapi_subapp.py +++ b/tests/test_custom_openapi_subapp.py @@ -9,14 +9,18 @@ sub_app = FastAPI( docs_url=None, redoc_url=None, openapi_url=None, - ) +) + @sub_app.get("/items/") async def read_items(): return {"id": "foo"} + @sub_app.get("/openapi.json") -async def openapi(): +async def openapi( + # Custom Deps +): return get_openapi( title="Custom OpenAPI", version="0.1", @@ -36,4 +40,5 @@ def test_sub_app_open_api(): assert response.headers["content-type"] == "application/json" paths = list(response.json()["paths"].keys()) assert paths == [ - "/sub_app/items/", "/sub_app/openapi.json",] + "/sub_app/items/", "/sub_app/openapi.json" + ] From 20bbf3ead01a2fc6e1f53217af59d7d528b1372e Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Sun, 6 Mar 2022 13:14:33 -0300 Subject: [PATCH 04/10] Fix code style --- fastapi/openapi/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index 46b685198..da7bebab8 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -423,7 +423,7 @@ def get_openapi( if result: path, security_schemes, path_definitions = result if prefix: - route.path_format= prefix + route.path_format + route.path_format = prefix + route.path_format if path: paths.setdefault(route.path_format, {}).update(path) if security_schemes: From 63cbea46b537c2d72d924562ad144cc0c4fa0fb7 Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Sun, 6 Mar 2022 13:21:55 -0300 Subject: [PATCH 05/10] Update test --- tests/test_custom_openapi_subapp.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/test_custom_openapi_subapp.py b/tests/test_custom_openapi_subapp.py index b0d96710f..d4884303d 100644 --- a/tests/test_custom_openapi_subapp.py +++ b/tests/test_custom_openapi_subapp.py @@ -2,7 +2,6 @@ from fastapi import FastAPI from fastapi.openapi.utils import get_openapi from fastapi.testclient import TestClient -swagger_ui_oauth2_redirect_url = "/docs/redirect" app = FastAPI() sub_app = FastAPI( From 472401c4a301f054657cc42a1f44f69548ed9ece Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky <16273730+LorhanSohaky@users.noreply.github.com> Date: Wed, 9 Mar 2022 08:33:15 -0300 Subject: [PATCH 06/10] Update fastapi/openapi/utils.py --- fastapi/openapi/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index da7bebab8..fe426f247 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -393,7 +393,7 @@ def get_openapi( terms_of_service: Optional[str] = None, contact: Optional[Dict[str, Union[str, Any]]] = None, license_info: Optional[Dict[str, Union[str, Any]]] = None, - prefix: Optional[str] = None, + prefix: Optional[str] = "", ) -> Dict[str, Any]: info: Dict[str, Any] = {"title": title, "version": version} if description: From d317a510308c261570ad06a3e8d224fc4d666a86 Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky <16273730+LorhanSohaky@users.noreply.github.com> Date: Wed, 9 Mar 2022 08:33:25 -0300 Subject: [PATCH 07/10] Update fastapi/openapi/utils.py --- fastapi/openapi/utils.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index fe426f247..792577570 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -422,8 +422,7 @@ def get_openapi( ) if result: path, security_schemes, path_definitions = result - if prefix: - route.path_format = prefix + route.path_format + route.path_format = prefix + route.path_format if path: paths.setdefault(route.path_format, {}).update(path) if security_schemes: From e1197217ede380fd67a385eabfc693e5c2c20972 Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Fri, 11 Mar 2022 06:38:47 -0300 Subject: [PATCH 08/10] Fix PR review --- fastapi/openapi/utils.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index 792577570..b2749c24c 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -393,7 +393,7 @@ def get_openapi( terms_of_service: Optional[str] = None, contact: Optional[Dict[str, Union[str, Any]]] = None, license_info: Optional[Dict[str, Union[str, Any]]] = None, - prefix: Optional[str] = "", + prefix: str = "", ) -> Dict[str, Any]: info: Dict[str, Any] = {"title": title, "version": version} if description: @@ -422,7 +422,7 @@ def get_openapi( ) if result: path, security_schemes, path_definitions = result - route.path_format = prefix + route.path_format + route.path_format = f"{prefix}{route.path_format}" if path: paths.setdefault(route.path_format, {}).update(path) if security_schemes: From 9c9066dd7877bf197b4b3d5ba2a6feed7694e1c4 Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Tue, 19 Apr 2022 04:31:31 -0300 Subject: [PATCH 09/10] Fix code style --- tests/test_custom_openapi_subapp.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/tests/test_custom_openapi_subapp.py b/tests/test_custom_openapi_subapp.py index d4884303d..191f87f76 100644 --- a/tests/test_custom_openapi_subapp.py +++ b/tests/test_custom_openapi_subapp.py @@ -2,7 +2,6 @@ from fastapi import FastAPI from fastapi.openapi.utils import get_openapi from fastapi.testclient import TestClient - app = FastAPI() sub_app = FastAPI( docs_url=None, @@ -27,6 +26,7 @@ async def openapi( prefix="/sub_app", ) + app.mount("/sub_app", sub_app) @@ -38,6 +38,4 @@ def test_sub_app_open_api(): assert response.status_code == 200, response.json() assert response.headers["content-type"] == "application/json" paths = list(response.json()["paths"].keys()) - assert paths == [ - "/sub_app/items/", "/sub_app/openapi.json" - ] + assert paths == ["/sub_app/items/", "/sub_app/openapi.json"] From 8296742ce8b49f941e18987fe1e61fc5c5292400 Mon Sep 17 00:00:00 2001 From: Lorhan Sohaky Date: Tue, 19 Jul 2022 21:05:08 -0300 Subject: [PATCH 10/10] Improve code coverage --- tests/test_custom_openapi_subapp.py | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/tests/test_custom_openapi_subapp.py b/tests/test_custom_openapi_subapp.py index 191f87f76..7b20af864 100644 --- a/tests/test_custom_openapi_subapp.py +++ b/tests/test_custom_openapi_subapp.py @@ -10,11 +10,6 @@ sub_app = FastAPI( ) -@sub_app.get("/items/") -async def read_items(): - return {"id": "foo"} - - @sub_app.get("/openapi.json") async def openapi( # Custom Deps @@ -38,4 +33,4 @@ def test_sub_app_open_api(): assert response.status_code == 200, response.json() assert response.headers["content-type"] == "application/json" paths = list(response.json()["paths"].keys()) - assert paths == ["/sub_app/items/", "/sub_app/openapi.json"] + assert paths == ["/sub_app/openapi.json"]