Swagger-UI (demo)

zms-publishing · Jun 29, 2023 · bffa645 · bffa645
1 parent 2fc967d
commit bffa645
Show file tree

Hide file tree

Showing 21 changed files with 212 additions and 0 deletions.
diff --git a/Products/zms/plugins/www/swagger-ui/favicon-16x16.png b/Products/zms/plugins/www/swagger-ui/favicon-16x16.png
diff --git a/Products/zms/plugins/www/swagger-ui/favicon-32x32.png b/Products/zms/plugins/www/swagger-ui/favicon-32x32.png
diff --git a/Products/zms/plugins/www/swagger-ui/index.css b/Products/zms/plugins/www/swagger-ui/index.css
@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}
diff --git a/Products/zms/plugins/www/swagger-ui/index.html b/Products/zms/plugins/www/swagger-ui/index.html
@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="index.css" />
+    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="./swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>
diff --git a/Products/zms/plugins/www/swagger-ui/oauth2-redirect.html b/Products/zms/plugins/www/swagger-ui/oauth2-redirect.html
@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1).replace('?', '&');
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&");
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value);
+                }
+        ) : {};
+
+        isValid = qp.state === sentState;
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode" ||
+          oauth2.auth.schema.get("flow") === "authorizationCode" ||
+          oauth2.auth.schema.get("flow") === "authorization_code"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg;
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>
diff --git a/Products/zms/plugins/www/swagger-ui/openapi.demo.yaml b/Products/zms/plugins/www/swagger-ui/openapi.demo.yaml
@@ -0,0 +1,24 @@
+openapi: 3.0.0
+info:
+  title: Sample API
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
+  version: 0.1.9
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+paths:
+  /users:
+    get:
+      summary: Returns a list of users.
+      description: Optional extended description in CommonMark or HTML.
+      responses:
+        '200':    # status code
+          description: A JSON array of user names
+          content:
+            application/json:
+              schema: 
+                type: array
+                items: 
+                  type: string
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-initializer.js b/Products/zms/plugins/www/swagger-ui/swagger-initializer.js
@@ -0,0 +1,20 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "https://petstore.swagger.io/v2/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-bundle.js b/Products/zms/plugins/www/swagger-ui/swagger-ui-bundle.js
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-bundle.js.map b/Products/zms/plugins/www/swagger-ui/swagger-ui-bundle.js.map
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle-core.js b/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle-core.js
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle-core.js.map b/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle-core.js.map
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle.js b/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle.js
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle.js.map b/Products/zms/plugins/www/swagger-ui/swagger-ui-es-bundle.js.map
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-standalone-preset.js b/Products/zms/plugins/www/swagger-ui/swagger-ui-standalone-preset.js
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui-standalone-preset.js.map b/Products/zms/plugins/www/swagger-ui/swagger-ui-standalone-preset.js.map
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui.css b/Products/zms/plugins/www/swagger-ui/swagger-ui.css
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui.css.map b/Products/zms/plugins/www/swagger-ui/swagger-ui.css.map
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui.js b/Products/zms/plugins/www/swagger-ui/swagger-ui.js
diff --git a/Products/zms/plugins/www/swagger-ui/swagger-ui.js.map b/Products/zms/plugins/www/swagger-ui/swagger-ui.js.map
diff --git a/Products/zms/zms.py b/Products/zms/zms.py
@@ -304,6 +304,7 @@ class ZMS(
 
     # Interface.
     # ----------
+    swagger_ui = PageTemplateFile('zpt/ZMS/swagger-ui', globals()) # swagger-ui
     index_html = PageTemplateFile('zpt/ZMS/index', globals()) # index_html
     f_index_html = PageTemplateFile('zpt/ZMS/index', globals()) # index_html
     f_headDoctype = PageTemplateFile('zpt/ZMS/f_headdoctype', globals()) # Head.DOCTYPE

diff --git a/Products/zms/zpt/ZMS/swagger-ui.zpt b/Products/zms/zpt/ZMS/swagger-ui.zpt
@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link type="text/css" rel="stylesheet" href="/++resource++zms_/swagger-ui/swagger-ui.css">
+    <link rel="shortcut icon" href="/++resource++zms_/swagger-ui/favicon-16x16.png">
+    <title>ZMSAPI - Swagger UI</title>
+  </head>
+  <body>
+    <div id="swagger-ui">
+    </div>
+  <script src="/++resource++zms_/swagger-ui/swagger-ui-bundle.js"></script>
+  <!-- `SwaggerUIBundle` is now available on the page -->
+  <script>
+    const ui = SwaggerUIBundle({
+        url: '/++resource++zms_/swagger-ui/openapi.demo.yaml',
+            "dom_id": "#swagger-ui",
+            "layout": "BaseLayout",
+            "deepLinking": true,
+            "showExtensions": true,
+            "showCommonExtensions": true,
+            "defaultModelsExpandDepth": -1,
+            presets: [
+                SwaggerUIBundle.presets.apis,
+                SwaggerUIBundle.SwaggerUIStandalonePreset
+                ],
+        })
+    </script>
+  </body>
+</html>
+