@akemona-org/strapi-plugin-documentation 3.7.0

package/middlewares/documentation/index.js

@@ -0,0 +1,59 @@
+'use strict';
+
+/**
+ * Module dependencies
+ */
+
+// Public node modules.
+const path = require('path');
+const _ = require('lodash');
+const swaggerUi = require('swagger-ui-dist');
+const koaStatic = require('koa-static');
+
+// Variables.
+const initialRoutes = [];
+
+module.exports = strapi => {
+  return {
+    beforeInitialize() {
+      strapi.config.middleware.load.before.push('documentation');
+
+      initialRoutes.push(..._.cloneDeep(strapi.plugins.documentation.config.routes));
+    },
+
+    initialize() {
+      // Find the plugins routes.
+      strapi.plugins.documentation.config.routes = strapi.plugins.documentation.config.routes.map(
+        (route, index) => {
+          if (route.handler === 'Documentation.getInfos') {
+            return route;
+          }
+
+          if (route.handler === 'Documentation.index' || route.path === '/login') {
+            route.config.policies = initialRoutes[index].config.policies;
+          }
+
+          // Set prefix to empty to be able to customise it.
+          if (_.get(strapi.plugins, ['documentation', 'config', 'x-strapi-config', 'path'])) {
+            route.config.prefix = '';
+            route.path = `/${strapi.plugins.documentation.config['x-strapi-config'].path}${route.path}`.replace(
+              '//',
+              '/'
+            );
+          }
+
+          return route;
+        }
+      );
+
+      strapi.router.get('/plugins/documentation/*', async (ctx, next) => {
+        ctx.url = path.basename(ctx.url);
+
+        return await koaStatic(swaggerUi.getAbsoluteFSPath(), {
+          maxage: strapi.config.middleware.settings.public.maxAge,
+          defer: true,
+        })(ctx, next);
+      });
+    },
+  };
+};

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@akemona-org/strapi-plugin-documentation",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "3.7.0",
+  "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
+  "strapi": {
+    "name": "Documentation",
+    "icon": "book",
+    "description": "documentation.plugin.description"
+  },
+  "scripts": {
+    "test": "echo \"no tests yet\""
+  },
+  "dependencies": {
+    "@akemona-org/strapi-helper-plugin": "3.7.0",
+    "@buffetjs/core": "3.3.8",
+    "@buffetjs/custom": "3.3.8",
+    "@buffetjs/hooks": "3.3.8",
+    "@buffetjs/icons": "3.3.8",
+    "@buffetjs/styles": "3.3.8",
+    "@buffetjs/utils": "3.3.8",
+    "cheerio": "^1.0.0-rc.5",
+    "fs-extra": "^9.1.0",
+    "immutable": "^3.8.2",
+    "jsonwebtoken": "^8.1.0",
+    "koa-static": "^5.0.0",
+    "lodash": "4.17.21",
+    "moment": "^2.29.4",
+    "path-to-regexp": "^3.1.0",
+    "react": "^16.14.0",
+    "react-copy-to-clipboard": "^5.0.3",
+    "react-dom": "^16.9.0",
+    "react-intl": "4.5.0",
+    "react-redux": "7.2.3",
+    "react-router": "^5.2.0",
+    "react-router-dom": "^5.0.0",
+    "reactstrap": "8.4.1",
+    "redux": "^4.0.1",
+    "redux-immutable": "^4.0.0",
+    "reselect": "^4.0.0",
+    "swagger-ui-dist": "3.47.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/akemona/strapi.git",
+    "directory": "packages/strapi-plugin-documentation"
+  },
+  "author": {
+    "name": "soupette",
+    "email": "strapi@akemona.com",
+    "url": "https://strapi.akemona.com"
+  },
+  "maintainers": [
+    {
+      "name": "Strapi",
+      "email": "strapi@akemona.com",
+      "url": "https://strapi.akemona.com"
+    },
+    {
+      "name": "soupette",
+      "email": "cyril@strapi.io"
+    },
+    {
+      "name": "lauriejim",
+      "email": "jim@strapi.io"
+    }
+  ],
+  "contributors": [
+    {
+      "name": "soupette"
+    },
+    {
+      "name": "Aurelsicoko",
+      "email": "aurelien@strapi.io"
+    },
+    {
+      "name": "lauriejim",
+      "email": "jim@strapi.io"
+    }
+  ],
+  "engines": {
+    "node": ">=10.16.0 <=14.x.x",
+    "npm": ">=6.0.0"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "gitHead": "129a8d6191b55810fd66448dcc47fee829df986c"
+}

package/public/index.html

@@ -0,0 +1,57 @@
+<!-- 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="<%=backendUrl%>/plugins/documentation/swagger-ui.css">
+    <link rel="icon" type="image/png" href="<%=backendUrl%>/plugins/documentation/favicon-32x32.png" sizes="32x32">
+    <link rel="icon" type="image/png" href="<%=backendUrl%>/plugins/documentation/favicon-16x16.png" sizes="16x16">
+    <style>
+      html
+      {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+      }
+
+      *,
+      *:before,
+      *:after
+      {
+        box-sizing: inherit;
+      }
+
+      body
+      {
+        margin:0;
+        background: #fafafa;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script class="custom-swagger-ui">
+      window.onload = function() {
+        const ui = SwaggerUIBundle({
+          url: "https://petstore.swagger.io/v2/swagger.json",
+          spec: <%=spec%>,
+          dom_id: '#swagger-ui',
+          docExpansion: "none",
+          deepLinking: true,
+          presets: [
+            SwaggerUIBundle.presets.apis,
+            SwaggerUIStandalonePreset,
+          ],
+          plugins: [
+            SwaggerUIBundle.plugins.DownloadUrl,
+          ],
+          layout: "StandaloneLayout",
+        });
+
+        window.ui = ui;
+      }
+    </script>
+
+    <script src="<%=backendUrl%>/plugins/documentation/swagger-ui-bundle.js"> </script>
+    <script src="<%=backendUrl%>/plugins/documentation/swagger-ui-standalone-preset.js"> </script>
+  </body>
+</html>

package/public/login.html

@@ -0,0 +1,135 @@
+<!DOCTYPE html><html><head>
+      <title>Login - Documentation</title>
+      <link href="https://fonts.googleapis.com/css?family=Lato:400,700" rel="stylesheet">
+      <style>
+        html {
+          font-size: 62.5%;
+          height: 100%;
+          margin: 0;
+          padding: 0;
+        }
+
+        body {
+          height: 100%;
+          margin: 0;
+          background-color: #ffffff;
+          font-family: 'Lato';
+          font-size: 1.4rem;
+          font-weight: 400;
+          text-rendering: optimizeLegibility;
+          -webkit-font-smoothing: antialiased;
+          -moz-osx-font-smoothing: grayscale;
+        }
+
+        .login {
+          height: 100%;
+          background-color: #F6F9FC;
+        }
+
+        .login .login-form {
+          height: calc(100% - 70px);
+          padding: 68px 0 0;
+          text-align: center;
+        }
+
+        .login .login-form form {
+          position: relative;
+          max-width: 460px;
+          padding: 26px 30px;
+          margin: 55px auto 0;
+          background-color: #ffffff;
+          border-radius: 3px;
+          box-shadow: 0px 2px 4px rgba(91, 107, 174, .15);
+          text-align: center;
+        }
+
+        .login .login-form form:before {
+          position: absolute;
+          content: '';
+          top: 0px;
+          left: 0;
+          display: inline-block;
+          width: 100%;
+          height: 2px;
+          background-color: #2B66CC;
+        }
+
+        .login .login-form form .error {
+          display: block;
+          color: #FF4E00;
+          padding-bottom: 20px;
+        }
+
+        .login .login-form .sub-title {
+          margin-top: 35px;
+          font-size: 1.6rem;
+          font-weight: 400;
+        }
+
+        .login .login-form .logo{
+          max-height: 40px;
+        }
+
+        .login .login-form form label {
+          display: block;
+          margin-bottom: 18px;
+          width: 100%;
+          text-align: left;
+          font-weight: 600;
+        }
+
+        .login .login-form form input {
+          outline: none;
+          width: calc(100% - 30px);
+          height: 36px;
+          padding: 0 15px;
+          border: 1px solid #ECECEC;
+          border-radius: 2px;
+          margin-bottom: 20px;
+          line-height: 36px;
+          text-align: left;
+        }
+
+        .login .login-form form input[type=submit] {
+          cursor: pointer;
+          display: inline-block;
+          width: auto;
+          margin: 12px auto 0;
+          padding: 0 75px;
+          background: transparent;
+          border-radius: 36px;
+          border: 1px solid #2B66CC;
+          color: #2B66CC;
+          text-transform: uppercase;
+          font-size: 1.4rem;
+          font-weight: 700;
+          transition: all .2s ease-out;
+        }
+
+        .login .login-form form input[type=submit]:hover {
+          background: #2B66CC;
+          color: #ffffff;
+        }
+      </style>
+    </head>
+    <body>
+      <div class="login">
+        <section class="login-form">
+          <div class="container">
+            <div class="row">
+              <div class="col-lg-6 col-lg-offset-3 col-md-12">
+                <img alt="Strapi logo" class="logo" src="https://strapi.akemona.com/assets/images/logo_login.png">
+                <h2 class="sub-title">Enter the password to access the documentation.</h2>
+                <form method="post" action="<%=actionUrl%>">
+                  <span class="error">Wrong password...</span>
+                  <label>Password</label>
+                  <input type="password" name="password" placeholder="&#x2022;&#x2022;&#x2022;&#x2022;&#x2022;&#x2022;&#x2022;&#x2022;&#x2022;">
+                  <input type="submit" value="Login">
+                </form>
+              </div>
+            </div>
+          </div>
+        </section>
+      </div>
+
+</body></html>