feat(openapi): bundle schema refs into openapi

Author: Nightapes

.gitignore

@@ -6,7 +6,7 @@
 /out-tsc
 
 # dependencies
-/node_modules
+**/node_modules
 
 # IDEs and editors
 /.idea

package-lock.json

@@ -36,9 +36,9 @@
     "packages/**"
   ],
   "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^10.1.0",
     "js-yaml": "^4.1.0",
     "openapi-types": "^12.0.2",
     "tslib": "^2.4.1"
   }
 }
-

package.json

@@ -18,6 +18,7 @@
   "dependencies": {
     "js-yaml": "^4.1.0",
     "tslib": "^2.0.0",
-    "openapi-types": "^10.0.0"
+    "openapi-types": "^10.0.0",
+    "@apidevtools/json-schema-ref-parser": "^10.1.0"
   }
 }

packages/serverless-openapi/package.json

@@ -1,28 +1,31 @@
 import Serverless from 'serverless';
 import { CustomProperties, customProperties } from './lib/custom.properties';
-import { OpenAPIV3 } from 'openapi-types';
 import { writeFileSync } from 'fs';
 import { functioneventProperties } from './lib/functionEvent.properties';
 import { dump } from 'js-yaml';
 import { CommandsDefinition } from './lib/comand.types';
 import { Generator } from './lib/generator';
 import { Log } from './lib/sls.types';
 
+import $RefParser from '@apidevtools/json-schema-ref-parser';
+import { readFile } from 'fs/promises';
+import * as path from 'path';
+
 export class ServerlessPlugin {
   serverless: Serverless;
   options: Serverless.Options & { [key: string]: any };
   hooks: { [key: string]: Serverless.FunctionDefinitionHandler };
   commands: CommandsDefinition;
-  log: Log
+  log: Log;
 
   constructor(
     serverless: Serverless,
     options: Serverless.Options & { [key: string]: any },
-    { log } : {log: Log}
+    { log }: { log: Log }
   ) {
     this.serverless = serverless;
     this.options = options;
-    this.log = log
+    this.log = log;
 
     this.commands = {
       openapi: {
@@ -55,15 +58,31 @@ export class ServerlessPlugin {
     };
   }
 
-  private generate() {
+  private async generate() {
     this.log.notice('Generate open api');
     const openApi = new Generator(this.log).generate(this.serverless);
     const customOpenApi = this.serverless.service.custom
       .openapi as CustomProperties;
-    this.saveToFile(openApi, customOpenApi.out);
+
+
+    const api = await $RefParser.bundle(openApi as any, {
+      resolve: {
+        file: {
+            canRead: ['.yml', '.json'],
+            read: async (ref) => {
+              const orgRef = (ref.url as string).replace(process.cwd(), "")
+              const realPath = path.join(process.cwd(), customOpenApi.schemaFolder, orgRef )
+              return await readFile(realPath)
+            }
+        }
+      }
+    });
+
+    this.log.debug(`API name: ${openApi.info.title}, Version: ${openApi.info.version}`);
+    this.saveToFile(api, customOpenApi.out);
   }
 
-  private saveToFile(openApi: OpenAPIV3.Document, out = 'openapi.json') {
+  private saveToFile(openApi: any, out = 'openapi.json') {
     if (this.options['out']) {
       out = this.options['out'];
     }
@@ -72,7 +91,7 @@ export class ServerlessPlugin {
     if (out.endsWith('.yaml') || out.endsWith('.yml')) {
       output = dump(JSON.parse(output));
     }
-    this.log.notice('Saved open api to '+ out);
+    this.log.notice('Saved open api to ' + out);
 
     writeFileSync(out, output);
   }

packages/serverless-openapi/src/index.ts

@@ -14,6 +14,7 @@ export interface CustomProperties {
   defaultResponse?: {
     'application/json': Schema;
   };
+  schemaFolder?: string;
 }
 
 export const customProperties: JSONSchema7 = {
@@ -22,6 +23,9 @@ export const customProperties: JSONSchema7 = {
       type: 'object',
       additionalProperties: false,
       properties: {
+        schemaFolder: {
+          type: 'string',
+        },
         out: {
           type: 'string',
         },

packages/serverless-openapi/src/lib/custom.properties.ts

@@ -3,7 +3,6 @@ import { OpenAPIV3 } from 'openapi-types';
 import { Schema } from './response.types';
 import { CustomProperties } from './custom.properties';
 import Aws, {
-  HttpAuthorizer,
   HttpRequestParametersValidation,
 } from 'serverless/plugins/aws/provider/awsProvider';
 import { Log } from './sls.types';

packages/serverless-openapi/src/lib/generator.ts

@@ -10,7 +10,7 @@
     "importHelpers": true,
     "target": "es2015",
     "module": "esnext",
-    "lib": ["es2017", "dom"],
+    "lib": ["es2017"],
     "skipLibCheck": true,
     "skipDefaultLibCheck": true,
     "baseUrl": ".",