@strapi/plugin-documentation 4.25.13 → 4.25.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.25.13",
+  "version": "4.25.15",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "repository": {
     "type": "git",
@@ -46,9 +46,9 @@
   },
   "dependencies": {
     "@strapi/design-system": "1.19.0",
-    "@strapi/helper-plugin": "4.25.13",
+    "@strapi/helper-plugin": "4.25.15",
     "@strapi/icons": "1.19.0",
-    "@strapi/utils": "4.25.13",
+    "@strapi/utils": "4.25.15",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.12",
     "formik": "2.4.0",
@@ -67,7 +67,7 @@
   "devDependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@strapi/pack-up": "4.23.0",
-    "@strapi/strapi": "4.25.13",
+    "@strapi/strapi": "4.25.15",
     "@testing-library/react": "14.0.0",
     "@testing-library/user-event": "14.4.3",
     "msw": "1.3.0",
@@ -93,5 +93,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "a41497dc67f990cc50ce1d0cf57f957d54e14b1a"
+  "gitHead": "58e6475628cf07196abad0fcb152ee7a089ee9bb"
 }

package/server/controllers/documentation.js

@@ -98,6 +98,36 @@ module.exports = {
     }
   },
 
+  async openapiJson(ctx) {
+    try {
+      const { major, minor, patch } = ctx.params;
+      const version =
+        major && minor && patch
+          ? `${major}.${minor}.${patch}`
+          : strapi.plugin('documentation').service('documentation').getDocumentationVersion();
+
+      const openAPISpecsPath = path.join(
+        strapi.dirs.app.extensions,
+        'documentation',
+        'documentation',
+        version,
+        'full_documentation.json'
+      );
+
+      try {
+        const documentation = fs.readFileSync(openAPISpecsPath, 'utf8');
+        const response = JSON.parse(documentation);
+
+        ctx.send(response);
+      } catch (e) {
+        strapi.log.error(e);
+        ctx.badRequest(null, e.message);
+      }
+    } catch (e) {
+      strapi.log.error(e);
+    }
+  },
+
   async loginView(ctx, next) {
     // lazy require cheerio
     const cheerio = require('cheerio');

package/server/routes/index.js

@@ -21,6 +21,24 @@ module.exports = [
       middlewares: [restrictAccess],
     },
   },
+  {
+    method: 'GET',
+    path: '/openapi.json',
+    handler: 'documentation.openapiJson',
+    config: {
+      auth: false,
+      middlewares: [restrictAccess],
+    },
+  },
+  {
+    method: 'GET',
+    path: '/v:major(\\d+).:minor(\\d+).:patch(\\d+)/openapi.json',
+    handler: 'documentation.openapiJson',
+    config: {
+      auth: false,
+      middlewares: [restrictAccess],
+    },
+  },
   {
     method: 'GET',
     path: '/login',

package/tests/server.js

@@ -19,6 +19,9 @@ const handlers = [
       })
     );
   }),
+  rest.post('*/openapi.json', (req, res, ctx) => {
+    return res(ctx.status(200));
+  }),
   rest.post('*/regenerateDoc', (req, res, ctx) => {
     return res(ctx.status(200));
   }),