expose swagger-ui index template variables to app configuration

MarcoRizk · Jul 6, 2021 · 41c937b · 41c937b
1 parent 1a7d089
commit 41c937b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/connexion/apis/aiohttp_api.py b/connexion/apis/aiohttp_api.py
@@ -237,7 +237,8 @@ async def redirect(request):
     async def _get_swagger_ui_home(self, req):
         base_path = self._base_path_for_prefix(req)
         template_variables = {
-            'openapi_spec_url': (base_path + self.options.openapi_spec_path)
+            'openapi_spec_url': (base_path + self.options.openapi_spec_path),
+            **self.options.openapi_console_ui_index_template_variables,
         }
         if self.options.openapi_console_ui_config is not None:
             template_variables['configUrl'] = 'swagger-ui-config.json'

diff --git a/connexion/apis/flask_api.py b/connexion/apis/flask_api.py
@@ -286,7 +286,8 @@ def console_ui_home(self):
             prefix=escaped
         )
         template_variables = {
-            'openapi_spec_url': flask.url_for(openapi_json_route_name)
+            'openapi_spec_url': flask.url_for(openapi_json_route_name),
+            **self.options.openapi_console_ui_index_template_variables,
         }
         if self.options.openapi_console_ui_config is not None:
             template_variables['configUrl'] = 'swagger-ui-config.json'

diff --git a/connexion/options.py b/connexion/options.py
@@ -122,6 +122,16 @@ def openapi_console_ui_config(self):
         """
         return self._options.get('swagger_ui_config', None)
 
+    @property
+    def openapi_console_ui_index_template_variables(self):
+        # type: () -> dict
+        """
+        Custom variables passed to the OpenAPI Console UI template.
+
+        Default: {}
+        """
+        return self._options.get('swagger_ui_template_arguments', {})
+
     @property
     def uri_parser_class(self):
         # type: () -> AbstractURIParser