You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2026/06/09 16:47:11 UTC
(superset) branch adopt/swagger-application-root created (now b53a6e0b118)
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a change to branch adopt/swagger-application-root
in repository https://gitbox.apache.org/repos/asf/superset.git
at b53a6e0b118 fix(swagger): support URL prefix via APPLICATION_ROOT in OpenAPI and Swagger UI
This branch includes the following new commits:
new b53a6e0b118 fix(swagger): support URL prefix via APPLICATION_ROOT in OpenAPI and Swagger UI
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(superset) 01/01: fix(swagger): support URL prefix via APPLICATION_ROOT in OpenAPI and Swagger UI
Posted by ru...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a commit to branch adopt/swagger-application-root
in repository https://gitbox.apache.org/repos/asf/superset.git
commit b53a6e0b11862299ce537e6443218317e75f94b9
Author: Claude Code <no...@anthropic.com>
AuthorDate: Tue Jun 9 09:46:50 2026 -0700
fix(swagger): support URL prefix via APPLICATION_ROOT in OpenAPI and Swagger UI
Adopts #34407 by @rsbhatti. Serves the OpenAPI spec and an APPLICATION_ROOT-aware
Swagger UI for Superset deployments behind a URL prefix (reverse proxy), gated by
a new FAB_API_SWAGGER_UI_SUPERSET_APP_ROOT flag (default False).
Adoption cleanups over the original:
- keep the existing FAB_API_SWAGGER_UI flag (the original removed it)
- drop an unrelated AUTH_ROLE_PUBLIC change that the original accidentally included
- add ASF license headers and type hints to the new openapi module
- fix the SupsersetSwaggerView -> SupersetSwaggerView class-name typo
- add a unit test for the schema-name resolver
Closes #34407
Fixes #33304
Co-authored-by: rsbhatti <ra...@gmail.com>
Co-Authored-By: Claude Opus 4.8 <no...@anthropic.com>
---
superset/config.py | 7 ++
superset/initialization/__init__.py | 4 ++
superset/openapi/__init__.py | 20 ++++++
superset/openapi/manager.py | 116 +++++++++++++++++++++++++++++++
tests/unit_tests/openapi/__init__.py | 16 +++++
tests/unit_tests/openapi/test_manager.py | 33 +++++++++
6 files changed, 196 insertions(+)
diff --git a/superset/config.py b/superset/config.py
index 6a040098792..7ebb47778fc 100644
--- a/superset/config.py
+++ b/superset/config.py
@@ -393,6 +393,13 @@ LOGO_RIGHT_TEXT: Callable[[], str] | str = ""
# ex: http://localhost:8080/swagger/v1
FAB_API_SWAGGER_UI = True
+# Enables an APPLICATION_ROOT-aware Swagger UI and OpenAPI spec, for Superset
+# deployments served behind a URL prefix (reverse proxy). When True, the spec
+# is exposed at ``/api/<version>/_openapi`` and the Swagger UI resolves it
+# through APPLICATION_ROOT. Defaults to False (standard FAB Swagger UI).
+# ex: http://localhost:8080/<prefix>/swagger/v1
+FAB_API_SWAGGER_UI_SUPERSET_APP_ROOT = False
+
# ----------------------------------------------------
# AUTHENTICATION CONFIG
# ----------------------------------------------------
diff --git a/superset/initialization/__init__.py b/superset/initialization/__init__.py
index 0b52b4a2452..e5f950fc47b 100644
--- a/superset/initialization/__init__.py
+++ b/superset/initialization/__init__.py
@@ -64,6 +64,7 @@ from superset.extensions import (
talisman,
)
from superset.extensions.context import extension_context
+from superset.openapi import SupersetOpenApi, SupersetSwaggerView
from superset.security import SupersetSecurityManager
from superset.semantic_layers.labels import database_connections_menu_label
from superset.sql.parse import SQLGLOT_DIALECTS
@@ -463,6 +464,9 @@ class SupersetAppInitializer: # pylint: disable=too-many-public-methods
appbuilder.add_view_no_menu(RedirectView)
appbuilder.add_view_no_menu(RoleRestAPI)
appbuilder.add_view_no_menu(UserInfoView)
+ if self.config.get("FAB_API_SWAGGER_UI_SUPERSET_APP_ROOT", False):
+ appbuilder.add_api(SupersetOpenApi)
+ appbuilder.add_view_no_menu(SupersetSwaggerView)
#
# Add links
diff --git a/superset/openapi/__init__.py b/superset/openapi/__init__.py
new file mode 100644
index 00000000000..5108157ef39
--- /dev/null
+++ b/superset/openapi/__init__.py
@@ -0,0 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from superset.openapi.manager import ( # noqa: F401
+ SupersetOpenApi,
+ SupersetSwaggerView,
+)
diff --git a/superset/openapi/manager.py b/superset/openapi/manager.py
new file mode 100644
index 00000000000..b233a437305
--- /dev/null
+++ b/superset/openapi/manager.py
@@ -0,0 +1,116 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""APPLICATION_ROOT-aware OpenAPI spec and Swagger UI.
+
+Serves the OpenAPI spec and Swagger UI in a way that works when Superset is
+deployed behind a URL prefix (reverse proxy) via ``APPLICATION_ROOT``. Enabled
+by the ``FAB_API_SWAGGER_UI_SUPERSET_APP_ROOT`` config flag.
+"""
+
+from typing import Any
+
+from apispec import APISpec
+from apispec.ext.marshmallow import MarshmallowPlugin
+from apispec.ext.marshmallow.common import resolve_schema_cls
+from flask import current_app, request
+from flask_appbuilder.api import BaseApi, expose, protect, safe
+from flask_appbuilder.baseviews import BaseView
+from flask_appbuilder.security.decorators import has_access
+
+from superset.superset_typing import FlaskResponse
+
+
+def resolver(schema: Any) -> str:
+ schema_cls = resolve_schema_cls(schema)
+ name = schema_cls.__name__
+ if name == "MetaSchema" and hasattr(schema_cls, "Meta"):
+ return f"{schema_cls.Meta.parent_schema_name}.{schema_cls.Meta.model.__name__}"
+ if name.endswith("Schema"):
+ return name[:-6] or name
+ return name
+
+
+class SupersetOpenApi(BaseApi):
+ route_base = "/api"
+ allow_browser_login = True
+
+ @expose("/<version>/_openapi")
+ @protect()
+ @safe
+ def get(self, version: str) -> FlaskResponse:
+ """Render the OpenAPI spec for every view that belongs to a version.
+ ---
+ get:
+ description: >-
+ Get the OpenAPI spec for a specific API version
+ parameters:
+ - in: path
+ schema:
+ type: string
+ name: version
+ responses:
+ 200:
+ description: The OpenAPI spec
+ content:
+ application/json:
+ schema:
+ type: object
+ 404:
+ $ref: '#/components/responses/404'
+ 500:
+ $ref: '#/components/responses/500'
+ """
+ version_found = False
+ api_spec = self._create_api_spec(version)
+ for base_api in current_app.appbuilder.baseviews:
+ if isinstance(base_api, BaseApi) and base_api.version == version:
+ base_api.add_api_spec(api_spec)
+ version_found = True
+ if version_found:
+ return self.response(200, **api_spec.to_dict())
+ return self.response_404()
+
+ @staticmethod
+ def _create_api_spec(version: str) -> APISpec:
+ app_root = current_app.config.get("APPLICATION_ROOT", "/")
+ default_server = {"url": request.host_url.rstrip("/") + app_root}
+ servers = current_app.config.get("FAB_OPENAPI_SERVERS", [default_server])
+ return APISpec(
+ title=current_app.appbuilder.app_name,
+ version=version,
+ openapi_version="3.0.2",
+ info={"description": current_app.appbuilder.app_name},
+ plugins=[MarshmallowPlugin(schema_name_resolver=resolver)],
+ servers=servers,
+ )
+
+
+class SupersetSwaggerView(BaseView):
+ route_base = "/swagger"
+ default_view = "show"
+ openapi_uri = "/api/{}/_openapi"
+
+ @expose("/<version>")
+ @has_access
+ def show(self, version: str) -> FlaskResponse:
+ app_root = current_app.config.get("APPLICATION_ROOT", "") + self.openapi_uri
+ return self.render_template(
+ current_app.config.get(
+ "FAB_API_SWAGGER_TEMPLATE", "appbuilder/swagger/swagger.html"
+ ),
+ openapi_uri=app_root.format(version),
+ )
diff --git a/tests/unit_tests/openapi/__init__.py b/tests/unit_tests/openapi/__init__.py
new file mode 100644
index 00000000000..13a83393a91
--- /dev/null
+++ b/tests/unit_tests/openapi/__init__.py
@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
diff --git a/tests/unit_tests/openapi/test_manager.py b/tests/unit_tests/openapi/test_manager.py
new file mode 100644
index 00000000000..43afd54e15f
--- /dev/null
+++ b/tests/unit_tests/openapi/test_manager.py
@@ -0,0 +1,33 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from marshmallow import Schema
+
+from superset.openapi.manager import resolver
+
+
+def test_resolver_strips_schema_suffix() -> None:
+ class FooSchema(Schema):
+ pass
+
+ assert resolver(FooSchema) == "Foo"
+
+
+def test_resolver_keeps_name_without_schema_suffix() -> None:
+ class Bar(Schema):
+ pass
+
+ assert resolver(Bar) == "Bar"