Feature/#22 open api 3 spec

.gitignore

@@ -5,4 +5,6 @@ build
 .idea
 *.iml
 test_spec.json
+test_spec_v3.json
 api-spec.json
+api-spec_v3.json

index.d.ts

@@ -8,11 +8,12 @@
  */
 
 import { Express } from 'express';
-import { OpenAPIV2 } from 'openapi-types';
+import { OpenAPIV2,OpenAPIV3 } from 'openapi-types';
 
 /** re-export for ease of use for the end user */
 export {
-	OpenAPIV2, //
+	OpenAPIV2,
+	OpenAPIV3
 };
 
 /** Options for `handleResponses` */
@@ -28,7 +29,9 @@ export interface HandleResponsesOptions {
 	specOutputPath?: string;
 
 	/** either the Swagger specification or a function with one argument, which returns the spec */
-	predefinedSpec?: object | OpenAPIV2.Document | ((spec: OpenAPIV2.Document) => OpenAPIV2.Document);
+	predefinedSpec?: object | OpenAPIV2.Document | OpenAPIV3.Document | 
+		((spec: OpenAPIV2.Document) => OpenAPIV2.Document) | 
+		((spec: OpenAPIV3.Document) => OpenAPIV3.Document);
 
 	/** how often to write the openAPI specification to file */
 	writeIntervalMs?: number;
@@ -91,4 +94,6 @@ export function init(
 
 export const getSpec: () => object | OpenAPIV2.Document;
 
+export const getSpecV3: (callback: (err: object | string, specV3: object | OpenAPIV3.Document) => void) => void
+
 export const setPackageInfoPath: (pkgInfoPath: string) => void;

index.js

@@ -10,8 +10,10 @@ const fs = require('fs');
 const path = require('path');
 const swaggerUi = require('swagger-ui-express');
 const utils = require('./lib/utils');
+
 const { generateMongooseModelsSpec } = require('./lib/mongoose');
 const { generateTagsSpec, matchingTags } = require('./lib/tags');
+const { convertOpenApiVersionToV3, getSpecByVersion, versions } = require('./lib/openapi');
 const processors = require('./lib/processors');
 const listEndpoints = require('express-list-endpoints');
 
@@ -97,11 +99,55 @@ function updateSpecFromPackage() {
 }
 
 /**
- * @description serve the openAPI docs with swagger at a specified path / url
+ * @description Builds api spec middleware
+ *
+ * @returns Middleware
+ */
+function apiSpecMiddleware(specV2, version) {
+  return (req, res) => {
+    getSpecByVersion(specV2, version, (err, openApiSpec) => {
+      if (!err) {
+        res.setHeader('Content-Type', 'application/json');
+        res.send(JSON.stringify(openApiSpec, null, 2));
+      }
+    });
+  };
+}
+
+/**
+ * @description Builds swagger serve middleware
+ *
+ * @returns Middleware
+ */
+function swaggerServeMiddleware(specV2, version) {
+  return (req, res) => {
+    getSpecByVersion(specV2, version, (err, openApiSpec) => {
+      if (!err) {
+        res.setHeader('Content-Type', 'text/html');
+        swaggerUi.setup(openApiSpec)(req, res);
+      }
+    });
+  };
+}
+
+/**
+ * @description Applies spec middlewares
+ */
+function applySpecMiddlewares(spec, version = '') {
+
+  const apiSpecBasePath = packageInfo.baseUrlPath.concat('/api-spec');
+  const baseSwaggerServePath = packageInfo.baseUrlPath.concat('/' + swaggerUiServePath);
+
+  app.use(apiSpecBasePath.concat('/' + version), apiSpecMiddleware(spec, version));
+  app.use(baseSwaggerServePath.concat('/' + version), swaggerUi.serve, swaggerServeMiddleware(spec, version));
+}
+
+/**
+ * @description Prepares spec to be served
  *
  * @returns void
  */
-function serveApiDocs() {
+function prepareSpec() {
   spec = { swagger: '2.0', paths: {} };
 
   const endpoints = listEndpoints(app);
@@ -141,15 +187,22 @@ function serveApiDocs() {
   spec.definitions = mongooseModelsSpecs || {};
   updateSpecFromPackage();
   spec = patchSpec(predefinedSpec);
-  app.use(packageInfo.baseUrlPath + '/api-spec', (req, res, next) => {
-    res.setHeader('Content-Type', 'application/json');
-    res.send(JSON.stringify(patchSpec(predefinedSpec), null, 2));
-    next();
-  });
-  app.use(packageInfo.baseUrlPath + '/' + swaggerUiServePath, swaggerUi.serve, (req, res) => {
-    res.setHeader('Content-Type', 'text/html');
-    swaggerUi.setup(patchSpec(predefinedSpec))(req, res);
-  });
+}
+
+/**
+ * @description serve the openAPI docs with swagger at a specified path / url
+ *
+ * @returns void
+ */
+function serveApiDocs() {
+  prepareSpec();
+
+  applySpecMiddlewares(spec, versions.OPEN_API_V2);
+
+  applySpecMiddlewares(spec, versions.OPEN_API_V3);
+
+  // Base path middleware should be applied after specific versions
+  applySpecMiddlewares(spec); 
 }
 
 /**
@@ -275,7 +328,7 @@ function handleResponses(expressApp,
 
   updateDefinitionsSpec(options.mongooseModels);
   updateTagsSpec(options.tags || options.mongooseModels);
-
+  
   /** middleware to handle RESPONSES */
   app.use((req, res, next) => {
     try {
@@ -289,17 +342,21 @@ function handleResponses(expressApp,
         firstResponseProcessing = false;
         lastRecordTime = ts;
 
-        fs.writeFile(specOutputPath, JSON.stringify(spec, null, 2), 'utf8', err => {
-          const fullPath = path.resolve(specOutputPath);
-
-          if (err) {
-            /**
-			 * TODO - this is broken - the error will be caught and ignored in the catch below.
-			 * See https://github.com/mpashkovskiy/express-oas-generator/pull/39#discussion_r340026645
-			 */
-            throw new Error(`Cannot store the specification into ${fullPath} because of ${err.message}`);
+        fs.writeFileSync(specOutputPath, JSON.stringify(spec, null, 2), 'utf8');
+
+        convertOpenApiVersionToV3(spec, (err, specV3) => {
+          if (!err) {
+            const parsedSpecOutputPath = path.parse(specOutputPath);
+            const {name, ext} = parsedSpecOutputPath;
+            parsedSpecOutputPath.base = name.concat('_').concat(versions.OPEN_API_V3).concat(ext);
+
+            const v3Path = path.format(parsedSpecOutputPath);
+
+            fs.writeFileSync(v3Path, JSON.stringify(specV3), 'utf8');
           }
-        });
+          /** TODO - Log that open api v3 could not be generated */
+        });  
+
       }
     } catch (e) {
       /** TODO - shouldn't we do something here? */
@@ -381,6 +438,13 @@ const getSpec = () => {
   return patchSpec(predefinedSpec);
 };
 
+/**
+ * @type { typeof import('./index').getSpecV3 }
+ */
+const getSpecV3 = callback => {
+  convertOpenApiVersionToV3(getSpec(), callback);
+};
+
 /**
  * @type { typeof import('./index').setPackageInfoPath }
  *
@@ -395,5 +459,6 @@ module.exports = {
   handleRequests,
   init,
   getSpec,
+  getSpecV3,
   setPackageInfoPath
 };

lib/openapi.js

@@ -0,0 +1,25 @@
+const openApiVersionConverter = require('swagger2openapi');
+
+module.exports.versions = {
+  OPEN_API_V2:'v2',
+  OPEN_API_V3:'v3'
+};
+
+module.exports.getSpecByVersion = (specV2, version, callback) => {
+  const defaultSpec = (specV2, callback) => callback(null, specV2);
+  const availableSpecs = {
+    [this.versions.OPEN_API_V2]: defaultSpec, 
+    [this.versions.OPEN_API_V3]: this.convertOpenApiVersionToV3,
+  };
+  const specByVersion = availableSpecs[version] || defaultSpec;
+
+  return specByVersion(specV2, callback);
+};
+
+module.exports.convertOpenApiVersionToV3 = (specV2, callback) => {
+  const options = {patch: true, warnOnly: true};
+
+  openApiVersionConverter.convertObj(specV2, options, function(err, results) {
+    callback(err, results && results.openapi);
+  });
+};