Merge pull request #1 from Deadarius/support-recursive-schema

Support recursive schema

Author: Deadarius

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documentation",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "description": "Serverless 1.0 plugin to generate OpenAPI V3 documentation from serverless configuration",
   "main": "index.js",
   "repository": {
@@ -39,6 +39,7 @@
     "@types/fs-extra": "^4.0.0",
     "@types/jest": "^20.0.2",
     "@types/js-yaml": "^3.5.31",
+    "@types/json-schema": "^7.0.3",
     "@types/node": "^8.0.7",
     "@types/uuid": "^3.0.0",
     "changelog-verify": "^1.0.4",
@@ -52,7 +53,6 @@
     "version-changelog": "^2.1.0"
   },
   "dependencies": {
-    "@jdw/jst": "^2.0.0-beta.9",
     "bluebird": "^3.5.0",
     "chalk": "^2.0.1",
     "fs-extra": "^4.0.1",

src/DefinitionGenerator.ts

@@ -1,9 +1,10 @@
-import { dereference } from '@jdw/jst';
+import { JSONSchema7 } from 'json-schema';
 // tslint:disable-next-line no-submodule-imports
 import { validateSync as openApiValidatorSync } from 'swagger2openapi/validate';
 import * as uuid from 'uuid';
+
 import { IDefinition, IDefinitionConfig, IOperation, IParameterConfig, IServerlessFunctionConfig } from './types';
-import { clone, isIterable, merge } from './utils';
+import { clone, isIterable, merge, omit } from './utils';
 
 export class DefinitionGenerator {
   // The OpenAPI version we currently validate against
@@ -49,9 +50,16 @@ export class DefinitionGenerator {
           continue;
         }
 
-        this.definition.components.schemas[model.name] = this.cleanSchema(
-          dereference(model.schema),
-        );
+        for (const definitionName of Object.keys(model.schema.definitions || {})) {
+          const definition = model.schema.definitions[definitionName];
+          if (typeof definition !== 'boolean') {
+            this.definition.components.schemas[definitionName] = this.cleanSchema(this.updateReferences(definition));
+          }
+        }
+
+        const schemaWithoutDefinitions = omit(model.schema, ['definitions']);
+
+        this.definition.components.schemas[model.name] = this.cleanSchema(this.updateReferences(schemaWithoutDefinitions));
       }
     }
 
@@ -116,6 +124,28 @@ export class DefinitionGenerator {
     return cleanedSchema;
   }
 
+  /**
+   * Walks through the schema object recursively and updates references to point to openapi's components
+   * @param schema JSON Schema Object
+   */
+  private updateReferences (schema: JSONSchema7): JSONSchema7 {
+    const cloned = clone(schema) as JSONSchema7;
+
+    if (cloned.$ref) {
+      cloned.$ref = cloned.$ref.replace('#/definitions', '#/components/schemas');
+    } else {
+      for (const key of Object.getOwnPropertyNames(cloned)) {
+        const value = cloned[key];
+
+        if (typeof value === 'object') {
+          cloned[key] = this.updateReferences(value);
+        }
+      }
+    }
+
+    return cloned;
+  }
+
   /**
    * Generate Operation objects from the Serverless Config.
    *

src/types.ts

@@ -1,9 +1,10 @@
+import { JSONSchema7 } from 'json-schema';
 
 export interface IModels {
   name: string;
   description: string;
   contentType: string;
-  schema: object | any[];
+  schema: JSONSchema7;
   examples: any[];
   example: object;
 }

src/utils.ts

@@ -10,3 +10,13 @@ export function isIterable (obj) {
 
   return typeof obj[Symbol.iterator] === 'function';
 }
+
+export function omit<T extends object> (obj: T, keys: string[]): T {
+  const cloned = clone(obj);
+
+  for (const key of keys) {
+    delete cloned[key];
+  }
+
+  return cloned;
+}

test/project/models/RecursiveResponse.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "folder": {
+      "type": "object",
+      "title": "Folder Schema",
+      "properties": {
+        "id": {
+          "type": "string",
+          "example": "3ba1c69c-3c81-4d6d-b304-873d898b2e3c",
+          "format": "uuid"
+        },
+        "folders": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/folder"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": ["id", "name", "folders", "checklists"]
+    }
+  },
+  "type": "object",
+  "title": "Folders Response Schema",
+  "properties": {
+    "data": {
+      "$ref": "#/definitions/folder"
+    }
+  }
+}