Merge pull request #12 from apoloa/add_curl_scripts

Support for cURL script generation

Author: fmvilas

cli.js

@@ -33,6 +33,7 @@ program
   .option('-o, --output <outputDir>', 'directory where to put the generated files (defaults to current directory)', parseOutput, process.cwd())
   .option('-t, --templates <templateDir>', 'directory where templates are located (defaults to internal nodejs templates)')
   .option('-b, --basedir <baseDir>', 'directory to use as the base when resolving local file references (defaults to OpenAPI file directory)')
+  .option('-c, --curl', 'generate a curl scripts', false)
   .parse(process.argv);
 
 if (!openapiFile) {
@@ -45,6 +46,7 @@ generator.generate({
   base_dir: program.basedir || baseDir || process.cwd(),
   target_dir: program.output,
   templates: program.templates ? path.resolve(process.cwd(), program.templates) : undefined,
+  curl: program.curl,
   template,
 }).then(() => {
   console.log(green('Done! ✨'));

lib/beautifier.js

@@ -2,12 +2,13 @@ const OpenAPISampler = require('openapi-sampler');
 const _ = require('lodash');
 const slugg = require('slugg');
 const md = require('markdown-it')();
+const curlGenerator = require('./curl-builder');
 
 const sharedStart = (array) => {
   const A = array.concat().sort();
-  const a1 = A[0], a2= A[A.length-1], L= a1.length;
+  const a1 = A[0], a2 = A[A.length - 1], L = a1.length;
   let i = 0;
-  while (i<L && a1.charAt(i)=== a2.charAt(i)) i++;
+  while (i < L && a1.charAt(i) === a2.charAt(i)) i++;
   return a1.substring(0, i);
 };
 
@@ -63,7 +64,7 @@ const beautifySchema = (schema) => {
   return schema;
 };
 
-const beautifyOperation = (operation, operationName, pathName) => {
+const beautifyOperation = (operation, operationName, pathName, options) => {
   operation.slug = slugg(`op-${operationName}-${pathName}`);
   operation.summaryAsHTML = mdToHTML(operation.summary);
   operation.descriptionAsHTML = mdToHTML(operation.description);
@@ -89,6 +90,10 @@ const beautifyOperation = (operation, operationName, pathName) => {
     operation.queryParams = operation.parameters.filter(p => p.in === 'query');
     operation.pathParams = operation.parameters.filter(p => p.in === 'path');
     operation.cookieParams = operation.parameters.filter(p => p.in === 'cookie');
+
+  }
+  if (options.curl) {
+    operation.curl = curlGenerator(operation, operationName, pathName);
   }
 
   if (operation.responses) {
@@ -118,7 +123,7 @@ const cleanBrackets = text => {
   return finalText;
 };
 
-module.exports = (openapi) => {
+module.exports = (openapi, config) => {
   openapi.basePath = openapi.basePath || '';
   openapi.info = openapi.info || {};
   openapi.info.descriptionAsHTML = mdToHTML(openapi.info.description);
@@ -168,7 +173,7 @@ module.exports = (openapi) => {
     const httpMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'COPY', 'HEAD', 'OPTIONS', 'LINK', 'UNLIK', 'PURGE', 'LOCK', 'UNLOCK', 'PROPFIND'];
 
     _.each(path, (operation, operationName) => {
-      if (httpMethods.includes(operationName.toUpperCase())) beautifyOperation(operation, operationName, pathName);
+      if (httpMethods.includes(operationName.toUpperCase())) beautifyOperation(operation, operationName, pathName, config);
     });
   });
 

lib/curl-builder.js

@@ -0,0 +1,90 @@
+const CONTENT_TYPE_HEADER = "Content-Type";
+
+const curlBuilder = (operation, operationName, pathName) => {
+  if (operation.requestBody && operation.requestBody.content) {
+    return Object.keys(operation.requestBody.content).map((content) =>
+      generateBodyBashPerContentType(operation, operationName, pathName, content,
+        operation.requestBody.content[content].schema.generatedExample || operation.requestBody.content[content].schema.example)
+    ).join("\n");
+  }
+  return generateBodyCurl(operation, operationName, pathName);
+};
+
+function generateBodyCurl(operation, operationName, pathName) {
+
+  let curlBuilder = new CurlBuilder(operationName, pathName, operation.pathParams);
+
+  if (operation.headers) {
+    curlBuilder = curlBuilder.withHeaders(operation.headers)
+  }
+
+  return curlBuilder.build();
+}
+
+function generateBodyBashPerContentType(operation, operationName, pathName, contentType, requestBody) {
+
+  let curlBuilder = new CurlBuilder(operationName, pathName, operation.pathParams, operation.queryParams)
+    .withContentTypeCurlHeader(contentType)
+    .withContentTypeHeader(contentType)
+    .withRequestBody(requestBody);
+  if (operation.headers) {
+    curlBuilder = curlBuilder.withHeaders(operation.headers)
+  }
+
+  return curlBuilder.build();
+
+}
+
+class CurlBuilder {
+  constructor(operationName, pathName, pathParams, queryParams) {
+    let query = "";
+    if (queryParams) {
+      query = "?" + queryParams
+        .map(queryParam => `${queryParam.name}=${queryParam.example || queryParam.name}`)
+        .join("&");
+    }
+    if (pathParams) {
+      pathParams.forEach(pathParams => {
+        pathName = pathName.replace(`{${pathParams.name}}`, pathParams.example || pathParams.name)
+      })
+    }
+    this.headers = [];
+    this.body = "";
+    this.curl = `curl -X "${operationName.toUpperCase()}" "${pathName}" \\`;
+  }
+
+  withContentTypeCurlHeader(contentType) {
+    this.curl = `# ${contentType} \n` + this.curl;
+    return this;
+  }
+
+  withContentTypeHeader(contentType) {
+    this.headers.push(`-H '${CONTENT_TYPE_HEADER}: ${contentType}' \\`);
+    return this;
+  }
+
+  withHeaders(headers) {
+    this.headers.push(...headers
+      .map(header => `-H '${header.name}: ${header.example || header.name}' \\`));
+    return this;
+  }
+
+  withRequestBody(requestBody) {
+    this.body += `-d $'{${JSON.stringify(requestBody)}} \\`;
+    return this;
+  }
+
+  build() {
+    let curlScript = this.curl;
+    if (this.headers.length !== 0) {
+      curlScript += "\n" + this.headers.join("\n")
+    }
+    if (this.body.length !== 0) {
+      curlScript += "\n" + this.body;
+    }
+    return curlScript.substr(0, curlScript.length - 1)
+  }
+
+}
+
+module.exports = curlBuilder;

lib/generator.js

@@ -286,7 +286,7 @@ codegen.generate = config => new Promise((resolve, reject) => {
   bundle(config.openapi, config.base_dir)
     .catch(reject)
     .then((openapi) => {
-      openapi = beautifier(openapi);
+      openapi = beautifier(openapi, config);
 
       const randomTitle = randomName().dashed;
       config.openapi = openapi;

templates/markdown/.partials/curl.md

@@ -0,0 +1,5 @@
+##### cURL Script (generated)
+
+```
+{{{curl}}}
+```

templates/markdown/.partials/operation.md

@@ -8,6 +8,10 @@
 {{{operation.description}}}
 {{/if}}
 
+{{#if operation.curl}}
+{{> curl curl=operation.curl}}
+{{/if}}
+
 {{#if operation.pathParams}}
 {{> pathParams pathParams=operation.pathParams}}
 {{/if}}