Add swagger UI interface (#10)

* Add swagger UI interface * Add swagger UI
cowprotocol · Apr 16, 2024 · c37ae3e · c37ae3e
1 parent ad551c1
commit c37ae3e
Show file tree

Hide file tree

Showing 22 changed files with 196 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,6 +4,10 @@ This project is a Content Management System for the [cow.fi](https://cow.fi).
 
 > It is an instance of Strapi, a headless CMS.
 
+# API
+Swagger Docs: https://cms.cow.fi/swagger.html
+
+
 # 👨‍💻 Develop
 
 ```

diff --git a/public/swagger-initializer.js b/public/swagger-initializer.js
@@ -0,0 +1,15 @@
+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: "/api/docs/openapi.json",
+    dom_id: "#swagger-ui",
+    deepLinking: true,
+    presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+    plugins: [SwaggerUIBundle.plugins.DownloadUrl],
+    layout: "StandaloneLayout",
+  });
+
+  //</editor-fold>
+};
diff --git a/public/swagger-ui-v5.15.2/favicon-16x16.png b/public/swagger-ui-v5.15.2/favicon-16x16.png
diff --git a/public/swagger-ui-v5.15.2/favicon-32x32.png b/public/swagger-ui-v5.15.2/favicon-32x32.png
diff --git a/public/swagger-ui-v5.15.2/index.css b/public/swagger-ui-v5.15.2/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/public/swagger-ui-v5.15.2/index.html b/public/swagger-ui-v5.15.2/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/public/swagger-ui-v5.15.2/oauth2-redirect.html b/public/swagger-ui-v5.15.2/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/public/swagger-ui-v5.15.2/swagger-initializer.js b/public/swagger-ui-v5.15.2/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/public/swagger-ui-v5.15.2/swagger-ui-bundle.js b/public/swagger-ui-v5.15.2/swagger-ui-bundle.js
diff --git a/public/swagger-ui-v5.15.2/swagger-ui-bundle.js.map b/public/swagger-ui-v5.15.2/swagger-ui-bundle.js.map
diff --git a/public/swagger-ui-v5.15.2/swagger-ui-es-bundle-core.js b/public/swagger-ui-v5.15.2/swagger-ui-es-bundle-core.js
diff --git a/public/swagger-ui-v5.15.2/swagger-ui-es-bundle-core.js.map b/public/swagger-ui-v5.15.2/swagger-ui-es-bundle-core.js.map
diff --git a/public/swagger-ui-v5.15.2/swagger-ui-es-bundle.js b/public/swagger-ui-v5.15.2/swagger-ui-es-bundle.js
diff --git a/public/swagger-ui-v5.15.2/swagger-ui-es-bundle.js.map b/public/swagger-ui-v5.15.2/swagger-ui-es-bundle.js.map
diff --git a/public/swagger-ui-v5.15.2/swagger-ui-standalone-preset.js b/public/swagger-ui-v5.15.2/swagger-ui-standalone-preset.js
diff --git a/public/swagger-ui-v5.15.2/swagger-ui-standalone-preset.js.map b/public/swagger-ui-v5.15.2/swagger-ui-standalone-preset.js.map
diff --git a/public/swagger-ui-v5.15.2/swagger-ui.css b/public/swagger-ui-v5.15.2/swagger-ui.css
diff --git a/public/swagger-ui-v5.15.2/swagger-ui.css.map b/public/swagger-ui-v5.15.2/swagger-ui.css.map
diff --git a/public/swagger-ui-v5.15.2/swagger-ui.js b/public/swagger-ui-v5.15.2/swagger-ui.js
diff --git a/public/swagger-ui-v5.15.2/swagger-ui.js.map b/public/swagger-ui-v5.15.2/swagger-ui.js.map
diff --git a/public/swagger.html b/public/swagger.html
@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>CMS - CoW Protocol</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui-v5.15.2/swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="./swagger-ui-v5.15.2/index.css" />
+    <link rel="icon" type="image/png" href="./swagger-ui-v5.15.2/favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./swagger-ui-v5.15.2/favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="./swagger-ui-v5.15.2/swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-v5.15.2/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="./swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>
diff --git a/src/extensions/documentation/documentation/1.0.0/full_documentation.json b/src/extensions/documentation/documentation/1.0.0/full_documentation.json
@@ -14,7 +14,7 @@
       "name": "Apache 2.0",
       "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
     },
-    "x-generation-date": "2023-10-10T16:55:12.115Z"
+    "x-generation-date": "2024-04-16T12:27:46.193Z"
   },
   "x-strapi-config": {
     "path": "/documentation",
-Original file line number
+Diff line change
@@ Expand Up @@
     > It is an instance of Strapi, a headless CMS.
+    # API
+    Swagger Docs: https://cms.cow.fi/swagger.html
     # 👨‍💻 Develop
     ```
@@ Expand Down @@