express-oas-generator/lib/utils.js

Module to automatically generate OpenAPI (Swagger) specification for existing ExpressJS 4.x REST API applications

/**
 * @fileOverview utils
 * @module lib/utils
 */

const generateSchema = require('generate-schema');

/**
 *
 * @param o
 */
module.exports.sortObject = o => {
  const sorted = {};
  let key;
  const a = [];
  for (key in o) {
    if (o.hasOwnProperty(key)) {
      a.push(key);
    }
  }
  a.sort();
  for (key = 0; key < a.length; key += 1) {
    sorted[a[key]] = o[a[key]];
  }
  return sorted;
};

/**
 *
 * @param obj
 * @returns {string}
 */
module.exports.getType = obj => {
  if ([true, false, 'true', 'false'].indexOf(obj) !== -1) {
    return 'boolean';
  }

  if (isNaN(obj)) {
    return {}.toString.call(obj).match(/\s([a-zA-Z]+)/)[1].toLowerCase();
  }

  if (`${obj}`.indexOf('.') !== -1) {
    return 'float';
  }

  return 'integer';
};

/**
 *
 * @param schema
 * @param vals
 */
const fillExamples = (schema, vals) => {
  for (const prop in schema.properties) {
    if (schema.properties[prop].type === 'object') {
      fillExamples(schema.properties[prop], vals[prop]);
    } else if (schema.properties[prop].type === 'array') {
      schema.properties[prop].example = [vals[prop][0]];
    } else {
      schema.properties[prop].example = prop === 'password' ? '******' : vals[prop];
    }
  }
};

/**
 *
 * @param json
 * @returns {{$schema}}
 */
module.exports.getSchema = json => {
  const schema = generateSchema.json(json);
  delete schema.$schema;
  fillExamples(schema, json);
  return schema;
};