Replace Swagger with OpenAPI where it makes sense

Author: fmvilas

README.md

@@ -60,11 +60,11 @@ Assuming we have the following OpenAPI Spec:
 openapi: "3.0.0"
 info:
   version: 1.0.0
-  title: Swagger Petstore
+  title: OpenAPI Petstore
   license:
     name: MIT
 servers:
-  - url: http://petstore.swagger.io/v1
+  - url: http://petstore.openapi.io/v1
 paths:
   /pet:
     get:...
@@ -108,7 +108,7 @@ In addition to that, the code generator adds a bit [more data](#data-passed-to-h
 #### Examples:
 ##### Dynamically require files in JavaScript
 ```mustache
-{{#each @root.swagger.endpoints}}
+{{#each @root.openapi.endpoints}}
 const {{.}} = require('./routes/{{.}}.route.js')
 {{/each}}
 ```
@@ -122,8 +122,7 @@ const user = require('./routes/user.route.js')
 | Param | Type | Description |
 | --- | --- | --- |
 |openapi|object|The OpenAPI spec.|
-|swagger|object|The OpenAPI spec (convenience alias).|
-|swagger.endpoints| object | All first level endpoints (e.g  `pet` and `user`) |
+|openapi.endpoints| object | All first level endpoints (e.g  `pet` and `user`) |
 
 ### Custom handlebars helpers
 If your template needs Handlebars helpers, you can define them in a directory called `.helpers` inside your template.

lib/generator.js

@@ -1,5 +1,5 @@
 /**
- * This module generates a code skeleton for an API using OpenAPI/Swagger.
+ * This module generates a code skeleton for an API using OpenAPI.
  * @module codegen
  */
 
@@ -74,7 +74,7 @@ const generateOperationFile = (config, operation, operation_name) => new Promise
       closebrace: '}' ,
       operation_name: operation_name.replace(/[}{]/g, ''),
       operation,
-      swagger: config.data.swagger
+      openapi: config.data.openapi
     });
 
     fs.writeFile(target_file, content, 'utf8', (err) => {
@@ -92,7 +92,7 @@ const generateOperationFile = (config, operation, operation_name) => new Promise
  */
 const generateOperationFiles = config => new Promise((resolve, reject) => {
   const files = {};
-  _.each(config.data.swagger.paths, (path, path_name) => {
+  _.each(config.data.openapi.paths, (path, path_name) => {
     const operation_name = path.endpointName;
     if (files[operation_name] === undefined) {
       files[operation_name] = [];
@@ -118,7 +118,7 @@ const generateOperationFiles = config => new Promise((resolve, reject) => {
  *
  * @private
  * @param  {Object}        config Configuration options
- * @param  {Object|String} config.swagger Swagger JSON or a string pointing to a Swagger file.
+ * @param  {Object|String} config.openapi OpenAPI JSON or a string pointing to a OpenAPI file.
  * @param  {String}        config.target_dir Absolute path to the directory where the files will be generated.
  * @param  {String}        config.templates Absolute path to the templates that should be used.
  * @return {Promise}
@@ -136,7 +136,7 @@ const generateDirectoryStructure = config => new Promise((resolve, reject) => {
   walker.on('file', async (root, stats, next) => {
     try {
       if (stats.name.includes('$$path$$')) {
-        // this file should be handled for each in swagger.paths
+        // this file should be handled for each in openapi.paths
         await generateOperationFiles({
           root,
           templates_dir,
@@ -269,11 +269,11 @@ const bundle = async (openapi, baseDir) => {
 };
 
 /**
- * Generates a code skeleton for an API given an OpenAPI/Swagger file.
+ * Generates a code skeleton for an API given an OpenAPI file.
  *
  * @module codegen.generate
  * @param  {Object}        config Configuration options
- * @param  {Object|String} config.openapi OpenAPI/Swagger JSON or a string pointing to an OpenAPI/Swagger file.
+ * @param  {Object|String} config.openapi OpenAPI JSON or a string pointing to an OpenAPI file.
  * @param  {String}        config.target_dir Path to the directory where the files will be generated.
  * @return {Promise}
  */
@@ -299,7 +299,6 @@ codegen.generate = config => new Promise((resolve, reject) => {
         templates: path.resolve(__dirname, '../templates')
       });
 
-      config.swagger = config.openapi;
       config.templates = `${config.templates}/${config.template}`;
 
       async function start () {

templates/express/README.md

@@ -1,3 +1,3 @@
-# {{swagger.info.title}}
+# {{openapi.info.title}}
 
-{{swagger.info.description}}
+{{openapi.info.description}}

templates/express/config/common.yml

@@ -3,7 +3,7 @@ defaults: &defaults
     port: 3000
 
   logger:
-    name: {{swagger.info.title}}
+    name: {{openapi.info.title}}
     level: debug
     levels:
       trace:

templates/express/package.json

@@ -1,7 +1,7 @@
 {
   "name": "{{package.name}}",
-  "description": "{{inline swagger.info.description}}",
-  "version": "{{swagger.info.version}}",
+  "description": "{{inline openapi.info.description}}",
+  "version": "{{openapi.info.version}}",
   "scripts": {
     "start": "node src/bin/www",
     "dev": "node src/bin/www | bunyan"

templates/express/src/api/index.js

@@ -14,11 +14,11 @@ app.use(cookieParser());
 /*
  * Routes
  */
-{{#each @root.swagger.endpoints}}
-{{#endsWith @root.swagger.basePath '/'}}
-app.use('{{@root.swagger.basePath}}{{..}}', require('./routes/{{..}}'));
+{{#each @root.openapi.endpoints}}
+{{#endsWith @root.openapi.basePath '/'}}
+app.use('{{@root.openapi.basePath}}{{..}}', require('./routes/{{..}}'));
 {{else}}
-app.use('{{@root.swagger.basePath}}/{{..}}', require('./routes/{{..}}'));
+app.use('{{@root.openapi.basePath}}/{{..}}', require('./routes/{{..}}'));
 {{/endsWith}}
 {{/each}}
 

templates/markdown/openapi.md

@@ -1,6 +1,6 @@
-# {{swagger.info.title}}
+# {{openapi.info.title}}
 
-{{{swagger.info.descriptionAsHTML}}}
+{{{openapi.info.descriptionAsHTML}}}
 
 ## Table of Contents