feat: added basic swagger generation + validation test

Author: Lukas Siemon

lib/api.js

@@ -1,29 +1,14 @@
-const fs = require("fs");
-const path = require("path");
 const get = require('lodash.get');
-const appRoot = require('app-root-path');
 const Rollbar = require('lambda-rollbar');
 const Limiter = require('lambda-rate-limiter');
 const param = require("./param");
 const response = require("./response");
+const swagger = require("./swagger");
+
+const endpoints = {};
 
 const Parser = (request, params) => {
-  fs.writeFileSync(path.join(appRoot.path, 'swagger', `${request}.json`), JSON.stringify({
-    swagger: "2.0",
-    paths: {
-      [`/${request.split(" ")[1]}`]: {
-        [request.split(" ")[0].toLowerCase()]: {
-          parameters: params.map(p => ({
-            name: p.name,
-            required: p.required,
-            type: p.constructor.name.toLowerCase(),
-            in: p.type
-          })),
-          responses: {}
-        }
-      }
-    }
-  }, null, 2));
+  endpoints[request] = params;
   return (event) => {
     let body;
     try {
@@ -80,6 +65,7 @@ module.exports = (options = {}) => {
 
   return {
     wrap,
+    generateSwagger: () => swagger(endpoints),
     ApiError: response.ApiError,
     ApiResponse: response.ApiResponse,
     JsonResponse: response.JsonResponse,

lib/param.js

@@ -1,7 +1,7 @@
 const get = require("lodash.get");
 const response = require("./response");
 
-const types = {
+const positionMapping = {
   query: "queryStringParameters",
   json: "body",
   path: "pathParameters",
@@ -10,10 +10,11 @@ const types = {
 };
 
 class Param {
-  constructor(name, type = 'query', required = true) {
+  constructor(name, position = 'query', required = true) {
     this.name = name;
-    this.type = type;
+    this.position = position;
     this.required = required;
+    this.type = null;
   }
 
   feed(event) {
@@ -26,13 +27,13 @@ class Param {
   }
 
   get() {
-    const result = get(this.event, `${types[this.type]}.${this.name}`);
+    const result = get(this.event, `${positionMapping[this.position]}.${this.name}`);
     if (result === undefined) {
       if (this.required) {
-        throw response.ApiError(`Required ${this.type}-Parameter "${this.name}" missing.`, 400, 99002);
+        throw response.ApiError(`Required ${this.position}-Parameter "${this.name}" missing.`, 400, 99002);
       }
     } else if (!this.validate(result)) {
-      throw response.ApiError(`Invalid Value for ${this.type}-Parameter "${this.name}" provided.`, 400, 99003, {
+      throw response.ApiError(`Invalid Value for ${this.position}-Parameter "${this.name}" provided.`, 400, 99003, {
         value: result
       });
     }
@@ -41,6 +42,10 @@ class Param {
 }
 
 class Str extends Param {
+  constructor(...args) {
+    super(...args);
+    this.type = "string";
+  }
   validate(value) {
     let valid = super.validate(value);
     if (!(typeof value === 'string' || value instanceof String)) {

lib/swagger.js

@@ -0,0 +1,48 @@
+module.exports = (endpoints) => {
+  const data = {
+    swagger: "2.0",
+    produces: ["application/json"],
+    info: {
+      title: "Api Name",
+      version: "0.0.1"
+    },
+    paths: {}
+  };
+  Object.keys(endpoints).forEach((request) => {
+    const parameters = endpoints[request].filter(p => p.position !== "json").map(p => ({
+      name: p.name,
+      required: p.required,
+      type: p.type,
+      in: p.position
+    }));
+
+    const jsonParams = endpoints[request].filter(p => p.position === "json");
+    if (jsonParams.length !== 0) {
+      parameters.push({
+        in: "body",
+        name: "bodyParamData",
+        schema: {
+          type: "object",
+          required: jsonParams.filter(p => p.required).map(p => p.name),
+          properties: Object.assign(...jsonParams.map(p => ({
+            [p.name]: {
+              type: p.type
+            }
+          })))
+        }
+      });
+    }
+    data.paths[`/${request.split(" ")[1]}`] = {
+      [request.split(" ")[0].toLowerCase()]: {
+        consumes: ["application/json"],
+        parameters,
+        responses: {
+          default: {
+            description: "Unexpected Error"
+          }
+        }
+      }
+    };
+  });
+  return data;
+};

package-lock.json

@@ -13,9 +13,11 @@
   ],
   "author": "Lukas Siemon",
   "devDependencies": {
+    "app-root-path": "2.0.1",
     "coveralls": "3.0.0",
     "js-gardener": "1.11.17",
-    "semantic-release": "12.4.1"
+    "semantic-release": "12.4.1",
+    "swagger-parser": "4.0.2"
   },
   "version": "0.0.0-development",
   "scripts": {
@@ -45,7 +47,6 @@
     "lib"
   ],
   "dependencies": {
-    "app-root-path": "2.0.1",
     "lambda-rate-limiter": "2.4.1",
     "lambda-rollbar": "1.8.2",
     "lambda-tdd": "1.11.10",