Added support for Swagger UI initOAuth method (#4)

Author: blueswen

CHANGELOG

@@ -1,3 +1,8 @@
+mkdocs-swagger-ui-tag 0.4.0 (2022-07-31)
+
+    * Added support for Swagger UI initOAuth method (#4)
+    * Updated swagger-ui-dist to 4.13.0
+
 mkdocs-swagger-ui-tag 0.3.2 (2022-07-16)
 
     * Fixed #2: Incompatible with mkdocs-material Instant loading feature

README.md

@@ -14,13 +14,14 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
 3. Synchronized dark mode with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
 4. Configure [Swagger UI configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/) through plugin options and tag attributes
 5. Support multiple OAS in single Swagger UI with top bar selector
+6. Support Swagger UI [initOAuth](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/) method
 
 ## Dependency
 
 1. Python Package
-    1. beautifulsoup4==4.11.1
+    1. beautifulsoup4>=4.11.1
 2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and css file
-    1. swagger-ui-dist==4.12.0
+    1. swagger-ui-dist>=4.13.0
 
 ## Usage
 

mkdocs_swagger_ui_tag/plugin.py

@@ -110,6 +110,7 @@ def on_post_page(self, output, page, config, **kwargs):
             iframe_filename = f"swagger-{cur_id}.html"
             iframe_id_list.append(cur_id)
             cur_options = self.process_options(swagger_ui_ele)
+            cur_oath2_prop = self.process_oath2_prop(swagger_ui_ele)
 
             openapi_spec_url = self.path_to_url(page.file,
                                                 swagger_ui_ele.get('src', ""))
@@ -119,7 +120,8 @@ def on_post_page(self, output, page, config, **kwargs):
                 background=self.config['background'],
                 id=cur_id,
                 openapi_spec_url=openapi_spec_url,
-                options=json.dumps(cur_options, indent=4)[1:-1])
+                options=json.dumps(cur_options, indent=4)[1:-1],
+                oath2_prop=json.dumps(cur_oath2_prop))
             with open(os.path.join(page_dir, iframe_filename), 'w') as f:
                 f.write(output_from_parsed_template)
             self.replace_with_iframe(soup, swagger_ui_ele, cur_id,
@@ -139,13 +141,15 @@ def on_post_page(self, output, page, config, **kwargs):
 
             # only use options from first grouped swagger ui tag
             cur_options = self.process_options(grouped_list[0])
+            cur_oath2_prop = self.process_oath2_prop(grouped_list[0])
             output_from_parsed_template = template.render(
                 css_dir=css_dir,
                 js_dir=js_dir,
                 background=self.config['background'],
                 id=cur_id,
                 openapi_spec_url=openapi_spec_url,
-                options=json.dumps(cur_options, indent=4)[1:-1])
+                options=json.dumps(cur_options, indent=4)[1:-1],
+                oath2_prop=json.dumps(cur_oath2_prop))
             with open(os.path.join(page_dir, iframe_filename), 'w') as f:
                 f.write(output_from_parsed_template)
             self.replace_with_iframe(soup, grouped_list[0], cur_id,
@@ -227,18 +231,22 @@ def process_options(self, swagger_ui_ele):
         options_keys = global_options.keys()
         cur_options = {}
         for k in options_keys:
-            cur_val = swagger_ui_ele.get(k.lower(), None)
-            if cur_val is not None:
+            val = swagger_ui_ele.get(k.lower(), None)
+            if val is not None:
                 if k == "supportedSubmitMethods":
                     try:
-                        cur_val = json.loads(cur_val.replace("'", '"'))
-                        if not isinstance(cur_val, list):
+                        val = json.loads(val.replace("'", '"'))
+                        if not isinstance(val, list):
                             raise ValueError(
-                                f"attribute supportedSubmitMethods: {cur_val} is not a list."
+                                f"Attribute supportedSubmitMethods: {val} is not a list."
                             )
-                    except:
-                        cur_val = global_options['supportedSubmitMethods']
-                cur_options[k] = cur_val
+                        cur_options[k] = val
+                    except Exception as e:
+                        logging.error(e)
+                        logging.error(
+                            "Ignore supportedSubmitMethods attribute setting.")
+                else:
+                    cur_options[k] = val
             else:
                 cur_options[k] = global_options[k]
             if cur_options[k] is None:
@@ -248,6 +256,44 @@ def process_options(self, swagger_ui_ele):
                 "syntaxHighlightTheme")
         return cur_options
 
+    def process_oath2_prop(self, swagger_ui_ele):
+        """ Retrieve Swagger UI OAuth 2.0 configuration from tag attributes """
+        oath_prop_keys = [
+            "clientId",
+            "clientSecret",
+            "realm",
+            "appName",
+            "scopes",
+            "additionalQueryStringParams",
+            "useBasicAuthenticationWithAccessCodeGrant",
+            "usePkceWithAuthorizationCodeGrant",
+        ]
+        cur_prop = {}
+        for k in oath_prop_keys:
+            val = swagger_ui_ele.get(k.lower(), None)
+            if val is not None:
+                if k == "additionalQueryStringParams":
+                    try:
+                        val = json.loads(val.replace("'", '"'))
+                        if not isinstance(val, dict):
+                            raise ValueError(
+                                f"attribute additionalQueryStringParams: {val} is not a dict."
+                            )
+                        cur_prop[k] = val
+                    except Exception as e:
+                        logging.error(e)
+                        logging.error(
+                            "Ignore additionalQueryStringParams attribute setting."
+                        )
+                elif k in [
+                        "useBasicAuthenticationWithAccessCodeGrant",
+                        "usePkceWithAuthorizationCodeGrant"
+                ]:
+                    cur_prop[k] = val.lower().strip() == "true"
+                else:
+                    cur_prop[k] = val
+        return cur_prop
+
     def on_post_build(self, config, **kwargs):
         """ Copy Swagger UI css and js files to assets directory """
 

mkdocs_swagger_ui_tag/swagger-ui/swagger.html

@@ -32,11 +32,17 @@
         {% endif %}
         {{options}}
       })
+
+      {% if oath2_prop != "{}" %}
+      window.ui.initOAuth({{oath2_prop}})
+      {% endif %}
+
       const scheme = parent.scheme
       if (scheme === "slate") {
           enable_dark_mode();
       }
     }
+
     const resize_ob = new ResizeObserver(function(entries) {
       parent.update_swagger_ui_iframe_height("{{id}}");
     });

setup.py

@@ -4,7 +4,7 @@
     long_description = f.read()
 
 setup(name="mkdocs-swagger-ui-tag",
-      version="0.3.2",
+      version="0.4.0",
       author="Blueswen",
       author_email="[email protected]",
       url="https://blueswen.github.io/mkdocs-swagger-ui-tag",