Merge pull request #77 from Mermade/v2

Use of remote templates

Author: MikeRalphson

README.md

@@ -3,11 +3,11 @@
 [![Build status](https://travis-ci.org/Mermade/openapi-codegen.svg?branch=master)](https://travis-ci.org/Mermade/openapi-codegen)
 [![Greenkeeper badge](https://badges.greenkeeper.io/Mermade/openapi-codegen.svg)](https://greenkeeper.io/)
 
-Experimental port of [swagger-codegen](https://github.com/swagger-api/swagger-codegen) templates to Node.js. This project was initially a 24-hour hackathon. The model adaptor code is entirely original and has been reverse-engineered from the existing documentation and template usage.
+Node.js-based codegen for OpenAPI documents. This project was initially a 24-hour hackathon. The local model adaptor code is entirely original and has been reverse-engineered from the existing documentation and template usage.
 
 **Work in progress**
 
-Supports OpenAPI 3.0.x natively, and Swagger/OpenAPI 1.2 and 2.0 by internal conversion
+Supports OpenAPI 3.0.x natively, and Swagger/OpenAPI 1.2 and 2.0 by internal conversion. Node.js LTS versions are supported.
 
 ## Usage
 
@@ -32,6 +32,8 @@ cg [options] {[path]configName} {openapi-definition}
 Options:
   --help           Show help                                           [boolean]
   --version        Show version number                                 [boolean]
+  --filter         Filter term to use with --list                       [string]
+  --list           List available templates for provider (og or sc)     [string]
   -d, --debug      Turn on debugging information in the model          [boolean]
   -f, --flat       Do not include config-name in output directory structure
                                                                        [boolean]
@@ -54,8 +56,6 @@ In this case, the generated code will be written to the `.out/nodejs` directory.
 
 You can also load the OpenAPI definition from a URL.
 
-If you are using Node 6.x or lower, please specify the `--harmony` flag.
-
 ### API
 
 ```javascript
@@ -66,15 +66,17 @@ renderer.main(definition,config,configName);
 
 ## Templates
 
-Templates are taken directly from `swagger-codegen`. This project is also licensed under [Apache-2.0](LICENSE) for this reason. Generated code is explicitly covered by the [Unlicense](templates/_common/UNLICENSE). Code to downconvert OpenAPI 3.0 definitions is taken from [Angular-Swagger-UI](https://github.com/Orange-OpenSource/angular-swagger-ui) and is MIT licensed.
+The local templates were taken directly from `swagger-codegen`. This project is also licensed under [Apache-2.0](LICENSE) for this reason. Generated code is explicitly covered by the [Unlicense](templates/_common/UNLICENSE). Code to downconvert OpenAPI 3.0 definitions is taken from [Angular-Swagger-UI](https://github.com/Orange-OpenSource/angular-swagger-ui) and is MIT licensed.
+
+You can also use the latest online templates from two providers: `og` ([openapi-generator](https://github.com/OpenAPITools/openapi-generator)) and `sc` ([swagger-codegen](https://github.com/swagger-api/swagger-codegen)). The `--list` and `--filter` options allow you to see which templates are available. Note that using the online templates involves sending your API definition to a remote server.
 
 ### Contributors
 
 See [here](https://github.com/swagger-api/swagger-codegen#template-creator) for a partial list of template contributors.
 
 ### Status of the template configurations
 
-The templates with a status have a working (if not necessarily tested) configuration in the **configs** directory.
+The local templates with a status have a working (if not necessarily tested) configuration in the **configs** directory. Contributions are welcomed from the community of new and updated configurations and template updates.
 
 <details>
 <summary>Click here to expand...</summary>
@@ -177,11 +179,3 @@ These templates are examples of how features of OpenAPI Codegen may be used, and
 
 * [See here](docs/README.md) - contributions welcome
 
-## See also
-
-These projects use their own template model, not that of `swagger-codegen`
-
-* https://github.com/fmvilas/swagger-node-codegen
-* https://github.com/wcandillon/swagger-js-codegen
-* https://github.com/Cian-Chambliss/swagger-codegen-prepare
-

cg.js

@@ -12,21 +12,33 @@ const fetch = require('node-fetch');
 const co = require('co');
 const swagger2openapi = require('swagger2openapi');
 const stools = require('swagger-tools');
+const mkdirp = require('mkdirp');
+const rimraf = require('rimraf');
 const admzip = require('adm-zip');
 
-const processor = require('./index.js');
+const processor = require('./local.js');
+const remote = require('./remote.js');
+
+async function list(provider, filter) {
+    process.exitCode = await remote.list(provider, filter);
+    process.exit();
+}
 
 var argv = require('yargs')
     .usage('cg [options] {[path]configName} {openapi-definition}')
     .boolean('debug')
     .alias('d','debug')
     .describe('debug','Turn on debugging information in the model')
+    .string('filter')
+    .describe('filter','Filter term to use with --list')
     .boolean('flat')
     .alias('f','flat')
     .describe('flat','Do not include config-name in output directory structure')
     .boolean('lint')
     .alias('l','lint')
     .describe('lint','Lint input definition')
+    .string('list')
+    .describe('list','List available templates for provider (og or sc)')
     .string('output')
     .alias('o','output')
     .describe('output','Specify output directory')
@@ -46,14 +58,21 @@ var argv = require('yargs')
     .version()
     .argv;
 
+if (argv.list) {
+    list(argv.list, argv.filter);
+}
+
 let configStr = argv._[0] || 'nodejs';
 let configName = path.basename(configStr);
+let remoteConfig = configName.indexOf(':')>-1;
 let configPath = path.dirname(configStr);
 if (!configPath || (configPath === '.')) configPath = './configs';
 let configFile = path.resolve(configPath,configName)+'.json';
-let config = require(configFile);
+let config = remoteConfig ? { defaults: {} } : require(configFile);
 let defName = argv._[1] || './defs/petstore3.json';
 
+let finish = remoteConfig ? finishRemote : finishLocal;
+
 config.outputDir = argv.output;
 config.templateDir = argv.templates;
 
@@ -70,7 +89,7 @@ function zipFile(filename,contents,encoding) {
     zipFiles[filename] = contents;
 }
 
-function finish(err,result) {
+function finishLocal(err,result) {
     if (argv.zip) {
         // create archive
         var zip = new admzip();
@@ -84,6 +103,38 @@ function finish(err,result) {
     }
 }
 
+function finishRemote(err,result) {
+   configName = configName.split(':').pop();
+   if (argv.verbose) console.log('Making/cleaning output directories');
+   mkdirp(path.join(config.outputDir,configName),function(){
+       rimraf(path.join(config.outputDir,configName)+'/*',function(){
+           if (argv.zip) {
+              fs.writeFileSync(path.join(config.outputDir,configName,configName+'.zip'),result);
+           }
+           else {
+               const zip = new admzip(result);
+               if (argv.verbose) {
+                   console.log('Unzipping...');
+                   const zipEntries = zip.getEntries(); // an array of ZipEntry records
+                   zipEntries.forEach(function(zipEntry) {
+                       console.log(zipEntry.entryName);
+                   });
+                }
+                zip.extractAllTo(config.outputDir,true);
+            }
+        });
+    });
+}
+
+function despatch(obj, config, configName, callback) {
+    if (remoteConfig) {
+        remote.main(obj, config, configName, callback);
+    }
+    else {
+        processor.main(obj, config, configName, callback);
+    }
+}
+
 function convert20(obj){
     if (argv.verbose) console.log('Converting OpenAPI 2.0 definition');
     swagger2openapi.convertObj(obj,{patch:true,warnOnly:true,direct:true},function(err,openapi){
@@ -92,7 +143,7 @@ function convert20(obj){
         }
         else {
             config.defaults.swagger = obj;
-            processor.main(openapi,config,configName,finish);
+            despatch(openapi,config,configName,finish);
         }
     });
 }
@@ -176,14 +227,19 @@ function main(s) {
     if (argv.verbose) console.log('Loaded definition '+defName);
 
     if (o && o.openapi) {
-        processor.main(o,config,configName,finish);
+        despatch(o,config,configName,finish);
     }
     else {
         if (o && o.swaggerVersion && o.swaggerVersion === '1.2') {
             convert12(o);
         }
         else if (o && o.swagger && o.swagger === '2.0') {
-            convert20(o);
+            if (remoteConfig) {
+                despatch(o,config,configName,finish);
+            }
+            else {
+                convert20(o);
+            }
         }
         else {
             console.error('Unrecognised OpenAPI/Swagger version');

docs/modelProperties.md

@@ -156,5 +156,5 @@
 |hasEnums|model|false||
 |vars|model|[array]||
 |isMapContainer|model|false|boolean - set to true when container is a map|
-|isArrayContainer|model|false|boolean - set to true when container is a array|
+|isArrayContainer|model|false|boolean - set to true when container is an array|
 |itemsComplexType|vars|OrderDetails|Stores the name of the model for array elements|

index.js local.js

@@ -2,7 +2,7 @@
   "name": "openapi-codegen",
   "version": "1.5.6",
   "description": "OpenAPI 3.0 CodeGen",
-  "main": "index.js",
+  "main": "local.js",
   "bin": {
     "cg": "./cg.js"
   },

package.json

@@ -0,0 +1,78 @@
+// @ts-check
+'use strict';
+
+const fetch = require('node-fetch');
+const util = require('util');
+
+function getServer(prefix) {
+    if (prefix === 'og') {
+        return 'https://api.openapi-generator.tech/api/gen/';
+    }
+    else if (prefix === 'sc') {
+        return 'https://generator.swagger.io/api/gen/';
+    }
+    console.warn('Unknown API provider prefix',prefix);
+    return false;
+}
+
+async function main(obj, config, configName, callback) {
+    const components = configName.split(':');
+    const prefix = components[0];
+    const type = components[1];
+    const template = components[2];
+    const server = getServer(prefix);
+    const body = { options: {}, spec: obj };
+    const response = await fetch(server+type+'s/'+template, {
+        method: 'post',
+        body:    JSON.stringify(body),
+        headers: { 'Content-Type': 'application/json' }
+    })
+    .then(res => res.json())
+    .then(json => json);
+    if (response.link) {
+        const zipfile = await fetch(response.link)
+        .then(res => res.buffer())
+        .then(buffer => buffer);
+        callback(null, zipfile);
+    }
+    else {
+        console.warn(util.inspect(response));
+    }
+}
+
+function format(templates, prefix, type, filter) {
+    for (let template of templates) {
+        if (!filter || (template.indexOf(filter)>-1)) {
+            console.log(prefix+':'+type+':'+template);
+        }
+    }
+}
+
+async function slurp(server, prefix, type, plural, filter) {
+    await fetch(server+plural)
+    .then(res => {
+        return res.text();
+    })
+    .then(data => {
+        format(JSON.parse(data), prefix, type, filter);
+    })
+    .catch(err => {
+        console.error(util.inspect(err));
+    });
+}
+
+async function list(prefix, filter) {
+    const server = getServer(prefix);
+    if (server) {
+        await slurp(server, prefix, 'client', 'clients', filter);
+        await slurp(server, prefix, 'server', 'servers', filter);
+        return 0;
+    }
+    return 1;
+}
+
+module.exports = {
+    main,
+    list
+};
+