@strapi/plugin-documentation 4.2.0-beta.2 → 4.2.0

package/server/services/helpers/build-api-endpoint-path.js

@@ -0,0 +1,185 @@
+'use strict';
+
+const _ = require('lodash');
+const pathToRegexp = require('path-to-regexp');
+
+const pascalCase = require('./utils/pascal-case');
+const queryParams = require('./utils/query-params');
+const loopContentTypeNames = require('./utils/loop-content-type-names');
+const getApiResponses = require('./utils/get-api-responses');
+const { hasFindMethod, isLocalizedPath } = require('./utils/routes');
+
+/**
+ * @description Parses a route with ':variable'
+ *
+ * @param {string} routePath - The route's path property
+ * @returns {string}
+ */
+const parsePathWithVariables = routePath => {
+  return pathToRegexp
+    .parse(routePath)
+    .map(token => {
+      if (_.isObject(token)) {
+        return token.prefix + '{' + token.name + '}';
+      }
+
+      return token;
+    })
+    .join('');
+};
+
+/**
+ * @description Builds the required object for a path parameter
+ *
+ * @param {string} routePath - The route's path property
+ *
+ * @returns {object } Swagger path params object
+ */
+const getPathParams = routePath => {
+  return pathToRegexp
+    .parse(routePath)
+    .filter(token => _.isObject(token))
+    .map(param => {
+      return {
+        name: param.name,
+        in: 'path',
+        description: '',
+        deprecated: false,
+        required: true,
+        schema: { type: 'string' },
+      };
+    });
+};
+
+/**
+ *
+ * @param {string} prefix - The prefix found on the routes object
+ * @param {string} route - The current route
+ * @property {string} route.path - The current route's path
+ * @property {object} route.config - The current route's config object
+ *
+ * @returns {string}
+ */
+const getPathWithPrefix = (prefix, route) => {
+  // When the prefix is set on the routes and
+  // the current route is not trying to remove it
+  if (prefix && !_.has(route.config, 'prefix')) {
+    // Add the prefix to the path
+    return prefix.concat(route.path);
+  }
+
+  // Otherwise just return path
+  return route.path;
+};
+/**
+ * @description Gets all paths based on routes
+ *
+ * @param {object} apiInfo
+ * @property {object} apiInfo.routeInfo - The api routes object
+ * @property {string} apiInfo.uniqueName - Content type name | Api name + Content type name
+ * @property {object} apiInfo.contentTypeInfo - The info object found on content type schemas
+ *
+ * @returns {object}
+ */
+const getPaths = ({ routeInfo, uniqueName, contentTypeInfo }) => {
+  // Get the routes for the current content type
+  const contentTypeRoutes = routeInfo.routes.filter(route => {
+    return (
+      route.path.includes(contentTypeInfo.pluralName) ||
+      route.path.includes(contentTypeInfo.singularName)
+    );
+  });
+
+  const paths = contentTypeRoutes.reduce((acc, route) => {
+    // TODO: Find a more reliable way to determine list of entities vs a single entity
+    const isListOfEntities = hasFindMethod(route.handler);
+    const isLocalizationPath = isLocalizedPath(route.path);
+    const methodVerb = route.method.toLowerCase();
+    const hasPathParams = route.path.includes('/:');
+    const pathWithPrefix = getPathWithPrefix(routeInfo.prefix, route);
+    const routePath = hasPathParams ? parsePathWithVariables(pathWithPrefix) : pathWithPrefix;
+    const { responses } = getApiResponses({
+      uniqueName,
+      route,
+      isListOfEntities,
+      isLocalizationPath,
+    });
+
+    const swaggerConfig = {
+      responses,
+      tags: [_.upperFirst(uniqueName)],
+      parameters: [],
+      operationId: `${methodVerb}${routePath}`,
+    };
+
+    if (isListOfEntities) {
+      swaggerConfig.parameters.push(...queryParams);
+    }
+
+    if (hasPathParams) {
+      const pathParams = getPathParams(route.path);
+      swaggerConfig.parameters.push(...pathParams);
+    }
+
+    if (['post', 'put'].includes(methodVerb)) {
+      const refName = isLocalizationPath ? 'LocalizationRequest' : 'Request';
+      const requestBody = {
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              $ref: `#/components/schemas/${pascalCase(uniqueName)}${refName}`,
+            },
+          },
+        },
+      };
+
+      swaggerConfig.requestBody = requestBody;
+    }
+
+    _.set(acc, `${routePath}.${methodVerb}`, swaggerConfig);
+
+    return acc;
+  }, {});
+
+  return paths;
+};
+
+/**
+ * @decription Gets all open api paths object for a given content type
+ *
+ * @param {object} apiInfo
+ *
+ * @returns {object} Open API paths
+ */
+const getAllPathsForContentType = apiInfo => {
+  let paths = {};
+
+  const pathsObject = getPaths(apiInfo);
+
+  paths = {
+    ...paths,
+    ...pathsObject,
+  };
+
+  return paths;
+};
+
+/**
+ * @description - Builds the Swagger paths object for each api
+ *
+ * @param {object} api - Information about the current api
+ * @property {string} api.name - The name of the api
+ * @property {string} api.getter - The getter for the api (api | plugin)
+ * @property {array} api.ctNames - The name of all contentTypes found on the api
+ *
+ * @returns {object}
+ */
+const buildApiEndpointPath = api => {
+  // A reusable loop for building paths and component schemas
+  // Uses the api param to build a new set of params for each content type
+  // Passes these new params to the function provided
+  return loopContentTypeNames(api, getAllPathsForContentType);
+};
+
+module.exports = buildApiEndpointPath;

package/server/services/helpers/build-component-schema.js

@@ -0,0 +1,156 @@
+'use strict';
+const _ = require('lodash');
+
+const cleanSchemaAttributes = require('./utils/clean-schema-attributes');
+const loopContentTypeNames = require('./utils/loop-content-type-names');
+const pascalCase = require('./utils/pascal-case');
+const { hasFindMethod, isLocalizedPath } = require('./utils/routes');
+
+/**
+ * @decription Get all open api schema objects for a given content type
+ *
+ * @param {object} apiInfo
+ * @property {string} apiInfo.uniqueName - Api name | Api name + Content type name
+ * @property {object} apiInfo.attributes - Attributes on content type
+ * @property {object} apiInfo.routeInfo - The routes for the api
+ *
+ * @returns {object} Open API schemas
+ */
+const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
+  // Store response and request schemas in an object
+  let schemas = {};
+  // Get all the route methods
+  const routeMethods = routeInfo.routes.map(route => route.method);
+  // Check for localized paths
+  const hasLocalizationPath = routeInfo.routes.filter(route => isLocalizedPath(route.path)).length;
+  // When the route methods contain any post or put requests
+  if (routeMethods.includes('POST') || routeMethods.includes('PUT')) {
+    const attributesToOmit = [
+      'createdAt',
+      'updatedAt',
+      'publishedAt',
+      'publishedBy',
+      'updatedBy',
+      'createdBy',
+      'localizations',
+    ];
+    const attributesForRequest = _.omit(attributes, attributesToOmit);
+
+    // Get a list of required attribute names
+    const requiredAttributes = Object.entries(attributesForRequest).reduce((acc, attribute) => {
+      const [attributeKey, attributeValue] = attribute;
+
+      if (attributeValue.required) {
+        acc.push(attributeKey);
+      }
+
+      return acc;
+    }, []);
+
+    if (hasLocalizationPath) {
+      schemas = {
+        ...schemas,
+        [`${pascalCase(uniqueName)}LocalizationRequest`]: {
+          required: [...requiredAttributes, 'locale'],
+          type: 'object',
+          properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
+        },
+      };
+    }
+
+    // Build the request schema
+    schemas = {
+      ...schemas,
+      [`${pascalCase(uniqueName)}Request`]: {
+        type: 'object',
+        required: ['data'],
+        properties: {
+          data: {
+            required: requiredAttributes,
+            type: 'object',
+            properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
+          },
+        },
+      },
+    };
+  }
+
+  if (hasLocalizationPath) {
+    schemas = {
+      ...schemas,
+      [`${pascalCase(uniqueName)}LocalizationResponse`]: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' },
+          ...cleanSchemaAttributes(attributes),
+        },
+      },
+    };
+  }
+
+  // Check for routes that need to return a list
+  const hasListOfEntities = routeInfo.routes.filter(route => hasFindMethod(route.handler)).length;
+  if (hasListOfEntities) {
+    // Build the list response schema
+    schemas = {
+      ...schemas,
+      [`${pascalCase(uniqueName)}ListResponse`]: {
+        type: 'object',
+        properties: {
+          data: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                id: { type: 'string' },
+                attributes: { type: 'object', properties: cleanSchemaAttributes(attributes) },
+              },
+            },
+          },
+          meta: {
+            type: 'object',
+            properties: {
+              pagination: {
+                properties: {
+                  page: { type: 'integer' },
+                  pageSize: { type: 'integer', minimum: 25 },
+                  pageCount: { type: 'integer', maximum: 1 },
+                  total: { type: 'integer' },
+                },
+              },
+            },
+          },
+        },
+      },
+    };
+  }
+
+  // Build the response schema
+  schemas = {
+    ...schemas,
+    [`${pascalCase(uniqueName)}Response`]: {
+      type: 'object',
+      properties: {
+        data: {
+          type: 'object',
+          properties: {
+            id: { type: 'string' },
+            attributes: { type: 'object', properties: cleanSchemaAttributes(attributes) },
+          },
+        },
+        meta: { type: 'object' },
+      },
+    },
+  };
+
+  return schemas;
+};
+
+const buildComponentSchema = api => {
+  // A reusable loop for building paths and component schemas
+  // Uses the api param to build a new set of params for each content type
+  // Passes these new params to the function provided
+  return loopContentTypeNames(api, getAllSchemasForContentType);
+};
+
+module.exports = buildComponentSchema;

package/server/services/helpers/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const builApiEndpointPath = require('./build-api-endpoint-path');
+const buildComponentSchema = require('./build-component-schema');
+
+module.exports = {
+  builApiEndpointPath,
+  buildComponentSchema,
+};

package/server/{utils → services/helpers/utils}/clean-schema-attributes.js

@@ -4,13 +4,12 @@ const _ = require('lodash');
 const getSchemaData = require('./get-schema-data');
 
 /**
- * @description - Converts types found on attributes to OpenAPI specific data types
+ * @description - Converts types found on attributes to OpenAPI acceptable data types
  *
  * @param {object} attributes - The attributes found on a contentType
  * @param {{ typeMap: Map, isRequest: boolean }} opts
  * @returns Attributes using OpenAPI acceptable data types
  */
-
 const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = false } = {}) => {
   const attributesCopy = _.cloneDeep(attributes);
 
@@ -170,6 +169,14 @@ const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = fa
           break;
         }
 
+        if (prop === 'localizations') {
+          attributesCopy[prop] = {
+            type: 'array',
+            items: { type: 'object', properties: {} },
+          };
+          break;
+        }
+
         if (!attribute.target || typeMap.has(attribute.target)) {
           attributesCopy[prop] = {
             type: 'object',

package/server/services/helpers/utils/get-api-responses.js

@@ -0,0 +1,105 @@
+'use strict';
+
+const pascalCase = require('./pascal-case');
+
+/**
+ * @description - Builds the Swagger response object for a given api
+ *
+ * @param {object} name - Name of the api or plugin
+ * @param {object} route - The current route
+ * @param {boolean} isListOfEntities - Checks for a list of entitities
+ *
+ * @returns The Swagger responses
+ */
+const getApiResponse = ({
+  uniqueName,
+  route,
+  isListOfEntities = false,
+  isLocalizationPath = false,
+}) => {
+  const getSchema = () => {
+    if (route.method === 'DELETE') {
+      return {
+        type: 'integer',
+        format: 'int64',
+      };
+    }
+
+    if (isLocalizationPath) {
+      return { $ref: `#/components/schemas/${pascalCase(uniqueName)}LocalizationResponse` };
+    }
+
+    if (isListOfEntities) {
+      return { $ref: `#/components/schemas/${pascalCase(uniqueName)}ListResponse` };
+    }
+
+    return { $ref: `#/components/schemas/${pascalCase(uniqueName)}Response` };
+  };
+
+  const schema = getSchema();
+
+  return {
+    responses: {
+      200: {
+        description: 'OK',
+        content: {
+          'application/json': {
+            schema,
+          },
+        },
+      },
+      400: {
+        description: 'Bad Request',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      401: {
+        description: 'Unauthorized',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      403: {
+        description: 'Forbidden',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      404: {
+        description: 'Not Found',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      500: {
+        description: 'Internal Server Error',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+    },
+  };
+};
+
+module.exports = getApiResponse;

package/server/services/helpers/utils/loop-content-type-names.js

@@ -0,0 +1,52 @@
+'use strict';
+const _ = require('lodash');
+
+/**
+ * @description A reusable loop for building api endpoint paths and component schemas
+ *
+ * @param {object} api - Api information to pass to the callback
+ * @param {function} callback - Logic to execute for the given api
+ *
+ * @returns {object}
+ */
+const loopContentTypeNames = (api, callback) => {
+  let result = {};
+  for (const contentTypeName of api.ctNames) {
+    // Get the attributes found on the api's contentType
+    const uid = `${api.getter}::${api.name}.${contentTypeName}`;
+    const { attributes, info: contentTypeInfo } = strapi.contentType(uid);
+
+    // Get the routes for the current api
+    const routeInfo =
+      api.getter === 'plugin'
+        ? strapi.plugin(api.name).routes['content-api']
+        : strapi.api[api.name].routes[contentTypeName];
+
+    // Continue to next iteration if routeInfo is undefined
+    if (!routeInfo) continue;
+
+    // Uppercase the first letter of the api name
+    const apiName = _.upperFirst(api.name);
+
+    // Create a unique name if the api name and contentType name don't match
+    const uniqueName =
+      api.name === contentTypeName ? apiName : `${apiName} - ${_.upperFirst(contentTypeName)}`;
+
+    const apiInfo = {
+      ...api,
+      routeInfo,
+      attributes,
+      uniqueName,
+      contentTypeInfo,
+    };
+
+    result = {
+      ...result,
+      ...callback(apiInfo),
+    };
+  }
+
+  return result;
+};
+
+module.exports = loopContentTypeNames;

package/server/services/helpers/utils/pascal-case.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const _ = require('lodash');
+
+const pascalCase = string => {
+  return _.upperFirst(_.camelCase(string));
+};
+
+module.exports = pascalCase;

package/server/services/helpers/utils/routes.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const hasFindMethod = handler => handler.split('.').pop() === 'find';
+
+const isLocalizedPath = routePath => routePath.includes('localizations');
+
+module.exports = {
+  isLocalizedPath,
+  hasFindMethod,
+};

package/server/services/utils/components.json

@@ -1,25 +0,0 @@
-{
-  "components": {
-    "securitySchemes": {
-      "bearerAuth": {
-        "type": "http",
-        "scheme": "bearer",
-        "bearerFormat": "JWT"
-      }
-    },
-    "schemas": {
-      "Error": {
-        "required": ["code", "message"],
-        "properties": {
-          "code": {
-            "type": "integer",
-            "format": "int32"
-          },
-          "message": {
-            "type": "string"
-          }
-        }
-      }
-    }
-  }
-}