Add support for URLs instead of files, and fix request bodies rendering

Author: fmvilas

README.md

@@ -20,7 +20,7 @@ npm install -g openapi3-generator
 ### From the command-line interface (CLI)
 
 ```bash
-  Usage: og [options] <openapiFile> <template>
+  Usage: og [options] <openapiFileOrURL> <template>
 
 
   Options:

cli.js

@@ -18,9 +18,14 @@ const parseOutput = dir => path.resolve(dir);
 
 program
   .version(packageInfo.version)
-  .arguments('<openapiFile> <template>')
+  .arguments('<openapiFileOrURL> <template>')
   .action((openapiFilePath, tmpl) => {
-    openapiFile = path.resolve(openapiFilePath);
+    if (!openapiFilePath.startsWith('http:') && !openapiFilePath.startsWith('https:')) {
+      openapiFile = path.resolve(openapiFilePath);
+    } else {
+      openapiFile = openapiFilePath;
+    }
+
     template = tmpl;
   })
   .option('-o, --output <outputDir>', 'directory where to put the generated files (defaults to current directory)', parseOutput, process.cwd())

lib/beautifier.js

@@ -17,7 +17,7 @@ const resolveAllOf = (schema) => {
       schemas.push(s);
     });
 
-    return resolveAllOf(_.merge({}, ...schemas));
+    return resolveAllOf(_.merge(...schemas));
   }
 
   if (schema.properties) {
@@ -31,36 +31,55 @@ const resolveAllOf = (schema) => {
       transformed[key] = schema.properties[key];
     }
 
-    return {
-      ...schema,
-      ...{ properties: transformed }
-    };
+    schema.properties = transformed;
+
+    return schema;
   }
 
   return schema;
 };
 
-const stringify = json => JSON.stringify(json || '', null, 2);
 const generateExample = schema => OpenAPISampler.sample(schema);
 
+const beautifySchema = (schema) => {
+  resolveAllOf(schema);
+  if (!schema.example) schema.generatedExample = generateExample(schema);
+
+  _.each(schema.properties, (prop) => {
+    if (prop.description) prop.descriptionAsHTML = md.render(prop.description || '');
+    if (prop.properties) beautifySchema(prop);
+  });
+  _.each(schema.additionalProperties, (prop) => {
+    if (prop.description) prop.descriptionAsHTML = md.render(prop.description || '');
+    if (prop.additionalProperties) beautifySchema(prop);
+  });
+
+  return schema;
+};
+
 const beautifyOperation = (operation) => {
   operation.summaryAsHTML = md.render(operation.summary || '');
   operation.descriptionAsHTML = md.render(operation.description || '');
 
+  if (operation.requestBody) {
+    _.each(operation.requestBody.content, (contentType) => {
+      if (contentType.schema) {
+        contentType.schema = beautifySchema(contentType.schema);
+      }
+    });
+  }
+
   if (operation.parameters) {
+    operation.parameters = operation.parameters.filter(p => p.in !== 'body');
     operation.parameters.filter(p => p.schema).forEach(param => resolveAllOf(param.schema));
 
-    if (operation.requestBody) {
-      operation.parameters = operation.parameters.filter(p => p.in !== 'body');
-    }
-
-    operation.parameters.forEach((param, index) => {
+    operation.parameters.forEach((param) => {
       param.descriptionAsHTML = md.render(param.description || '');
     });
   }
 
   if (operation.responses) {
-    _.each(operation.responses, (response, responseCode) => {
+    _.each(operation.responses, (response) => {
       if (response.content && response.content.schema) {
         resolveAllOf(response.content.schema);
       }
@@ -73,17 +92,6 @@ const beautifyOperation = (operation) => {
   return operation;
 };
 
-const beautifySchema = (schema) => {
-  _.each(schema.properties, (prop, propName) => {
-    if (prop.description) prop.descriptionAsHTML = md.render(prop.description || '');
-    if (prop.properties) beautifySchema(prop);
-  });
-  _.each(schema.additionalProperties, (prop, propName) => {
-    if (prop.description) prop.descriptionAsHTML = md.render(prop.description || '');
-    if (prop.additionalProperties) beautifySchema(prop);
-  });
-};
-
 const cleanBrackets = text => {
   let finalText = text;
 
@@ -98,6 +106,16 @@ module.exports = (openapi) => {
   openapi.info = openapi.info || {};
   openapi.info.descriptionAsHTML = md.render(openapi.info.description || '');
 
+  if (!openapi.components) openapi.components = {};
+  if (!openapi.components.schemas) {
+    openapi.__noSchemas = true;
+    openapi.components.schemas = {};
+  }
+
+  _.each(openapi.components.schemas, (schema, schemaName) => {
+    openapi.components.schemas[schemaName] = beautifySchema(schema);
+  });
+
   if (openapi.servers) {
     _.each(openapi.servers, server => {
       server.descriptionAsHTML = md.render(server.description || '');
@@ -141,23 +159,6 @@ module.exports = (openapi) => {
 
   openapi.endpoints = _.unique(_.pluck(openapi.paths, 'endpointName'));
 
-  if (!openapi.components) openapi.components = {};
-  if (!openapi.components.schemas) {
-    openapi.__noSchemas = true;
-    openapi.components.schemas = {};
-  }
-
-  _.each(openapi.components.schemas, (schema, schemaName) => {
-    schema = resolveAllOf(schema);
-    if (schema.example) {
-      schema.formattedExample = stringify(schema.example);
-    } else {
-      schema.generatedExample = stringify(generateExample(schema));
-    }
-    openapi.components.schemas[schemaName] = schema;
-    beautifySchema(schema);
-  });
-
   const commonPrefix = sharedStart(Object.keys(openapi.paths));
   const levels = commonPrefix.split('/').length - 1;
   openapi.__commonPrefix = commonPrefix.split('/').slice(0, levels).join('/');

lib/bundler.js

@@ -1,13 +1,46 @@
 const fs = require('fs');
 const path = require('path');
+const http = require('http');
+const https = require('https');
 const YAML = require('js-yaml');
 const RefParser = require('json-schema-ref-parser');
 const validator = require('oas-validator');
 
-async function getFileContent (filePath) {
+const handleHTTPResponse = (url, res, resolve, reject) => {
+  if (res.statusCode >= 400) return reject(`Can't get file ${url}`);
+
+  res.setEncoding('utf8');
+  let rawData = '';
+  res.on('data', (chunk) => { rawData += chunk; });
+  res.on('end', () => { resolve(rawData); });
+  res.on('error', reject);
+};
+
+function getContentFromURL (url) {
+  return new Promise((resolve, reject) => {
+    if (url.startsWith('http:')) {
+      http.get(url, (res) => {
+        handleHTTPResponse(url, res, resolve, reject);
+      }).on('error', reject);
+    } else if (url.startsWith('https:')) {
+      https.get(url, (res) => {
+        handleHTTPResponse(url, res, resolve, reject);
+      }).on('error', reject);
+    } else {
+      reject('Protocol not supported.');
+    }
+  });
+}
+
+function getFileContent (filePath) {
   return new Promise((resolve, reject) => {
     fs.readFile(path.resolve(__dirname, filePath), (err, content) => {
-      if (err) return reject(err);
+      if (err) {
+        getContentFromURL(filePath)
+          .catch(reject)
+          .then(content => resolve(content));
+        return;
+      }
       resolve(content);
     });
   });