fix(event_handler): correct URL for OpenAPI spec in Swagger UI

Author: tlinhart

aws_lambda_powertools/event_handler/api_gateway.py

@@ -1958,7 +1958,6 @@ def swagger_handler():
 
             body = generate_swagger_html(
                 escaped_spec,
-                f"{base_path}{path}",
                 swagger_js,
                 swagger_css,
                 swagger_base_url,

aws_lambda_powertools/event_handler/openapi/swagger_ui/html.py

@@ -5,7 +5,6 @@
 
 def generate_swagger_html(
     spec: str,
-    path: str,
     swagger_js: str,
     swagger_css: str,
     swagger_base_url: str,
@@ -19,8 +18,6 @@ def generate_swagger_html(
     ----------
     spec: str
         The OpenAPI spec
-    path: str
-        The path to the Swagger documentation
     swagger_js: str
        Swagger UI JavaScript source code or URL
     swagger_css: str
@@ -94,7 +91,7 @@ def generate_swagger_html(
   }}
 
   var ui = SwaggerUIBundle(swaggerUIOptions)
-  ui.specActions.updateUrl('{path}?format=json');
+  ui.specActions.updateUrl(currentUrl.pathname + "?format=json");
   {oauth2_content}
 </script>
 </html>

tests/functional/event_handler/_pydantic/test_openapi_swagger.py

@@ -91,33 +91,6 @@ def test_openapi_swagger_json_view_with_custom_path():
     assert "OpenAPI JSON View" in result["body"]
 
 
-def test_openapi_swagger_with_rest_api_default_stage():
-    app = APIGatewayRestResolver(enable_validation=True)
-    app.enable_swagger()
-
-    event = load_event("apiGatewayProxyEvent.json")
-    event["path"] = "/swagger"
-    event["requestContext"]["stage"] = "$default"
-
-    result = app(event, {})
-    assert result["statusCode"] == 200
-    assert "ui.specActions.updateUrl('/swagger?format=json')" in result["body"]
-
-
-def test_openapi_swagger_with_rest_api_stage():
-    app = APIGatewayRestResolver(enable_validation=True)
-    app.enable_swagger()
-
-    event = load_event("apiGatewayProxyEvent.json")
-    event["path"] = "/swagger"
-    event["requestContext"]["stage"] = "prod"
-    event["requestContext"]["path"] = "/prod/swagger"
-
-    result = app(event, {})
-    assert result["statusCode"] == 200
-    assert "ui.specActions.updateUrl('/prod/swagger?format=json')" in result["body"]
-
-
 def test_openapi_swagger_with_persist_authorization():
     app = APIGatewayRestResolver(enable_validation=True)
     app.enable_swagger(persist_authorization=True)