swagger-typescript-api-nextgen/src/swagger.js

Nextgen TypeScript/JavaScript API generator from Swagger schema

const _ = require("lodash");
const yaml = require("js-yaml");
const axios = require("axios");
const converter = require("swagger2openapi");
const https = require("https");
const { addToConfig, config } = require("./config");
const { pathIsExist, getFileContent } = require("./files");
const { logger } = require("./logger");

const parseSwaggerFile = (file) => {
  if (typeof file !== "string") return file;

  try {
    return JSON.parse(file);
  } catch (e) {
    return yaml.load(file);
  }
};

const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy) =>
  new Promise((resolve, reject) => {
    if (pathIsExist(pathToSwagger)) {
      logger.log(`try to get swagger by path "${pathToSwagger}"`);
      resolve(getFileContent(pathToSwagger));
    } else {
      logger.log(`try to get swagger by URL "${urlToSwagger}"`);
      // setup options for Axios
      const axiosOptions = {};
      //
      if (disableStrictSSL) {
        axiosOptions.httpsAgent = new https.Agent({
          rejectUnauthorized: false,
        });
      }
      //
      if (disableProxy) axiosOptions.proxy = false;
      //
      axios
        .get(urlToSwagger, axiosOptions)
        .then((res) => resolve(res.data))
        .catch(() => {
          const message = `error while getting swagger by URL ${urlToSwagger}`;

          logger.error(message);

          reject(message);
        });
    }
  });

const getSwaggerObject = (
  pathToSwagger,
  urlToSwagger,
  disableStrictSSL,
  disableProxy,
  converterOptions,
) =>
  getSwaggerFile(pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy).then((file) =>
    convertSwaggerObject(parseSwaggerFile(file), converterOptions),
  );

const convertSwaggerObject = (swaggerSchema, converterOptions) => {
  return new Promise((resolve) => {
    swaggerSchema.info = _.merge(
      {
        title: "No title",
        version: "",
      },
      swaggerSchema.info,
    );

    if (!swaggerSchema.openapi) {
      swaggerSchema.paths = _.merge({}, swaggerSchema.paths);

      converter.convertObj(
        swaggerSchema,
        {
          ...converterOptions,
          warnOnly: true,
          refSiblings: "preserve",
          rbname: "requestBodyName",
        },
        function (err, options) {
          const parsedSwaggerSchema = _.get(err, "options.openapi", _.get(options, "openapi"));
          if (!parsedSwaggerSchema && err) {
            throw new Error(err);
          }
          addToConfig({ convertedFromSwagger2: true });
          resolve({
            usageSchema: parsedSwaggerSchema,
            originalSchema: swaggerSchema,
          });
        },
      );
    } else {
      resolve({
        usageSchema: swaggerSchema,
        originalSchema: swaggerSchema,
      });
    }
  });
};

const fixSwaggerScheme = (usage, original) => {
  const usagePaths = _.get(usage, "paths");
  const originalPaths = _.get(original, "paths");

  // walk by routes
  _.each(usagePaths, (usagePathObject, route) => {
    const originalPathObject = _.get(originalPaths, route);

    // walk by methods
    _.each(usagePathObject, (usageRouteInfo, methodName) => {
      const originalRouteInfo = _.get(originalPathObject, methodName);
      const usageRouteParams = _.get(usageRouteInfo, "parameters", []);
      const originalRouteParams = _.get(originalRouteInfo, "parameters", []);

      usageRouteInfo.consumes = _.uniq(
        _.compact([...(usageRouteInfo.consumes || []), ...(originalRouteInfo.consumes || [])]),
      );
      usageRouteInfo.produces = _.uniq(
        _.compact([...(usageRouteInfo.produces || []), ...(originalRouteInfo.produces || [])]),
      );

      _.each(originalRouteParams, (originalRouteParam) => {
        const existUsageParam = _.find(
          usageRouteParams,
          (param) => originalRouteParam.in === param.in && originalRouteParam.name === param.name,
        );
        if (!existUsageParam) {
          usageRouteParams.push(originalRouteParam);
        }
      });
    });
  });
};

module.exports = {
  getSwaggerObject,
  fixSwaggerScheme,
  convertSwaggerObject,
};