Merge pull request #6 from drGrove/master

Adds object merging to allow for swagger docs of same endpoint with different http methods

Author: chdanielmueller

example/routes.js

@@ -44,4 +44,43 @@ module.exports.setup = function(app) {
   app.post('/login', function(req, res) {
     res.json(req.body);
   });
-};
+
+  /**
+   * @swagger
+   * /users:
+   *   get:
+   *     description: Returns users
+   *     produces:
+   *      - application/json
+   *     responses:
+   *       200:
+   *         description: users
+   */
+  app.get('/users', function(req, res) {
+    res.json({
+      username: 'jsmith',
+    });
+  });
+
+  /**
+   * @swagger
+   * /users:
+   *   post:
+   *     description: Returns users
+   *     produces:
+   *       - application/json
+   *     parameters:
+   *       - name: username
+   *         description: username for user
+   *         in: formData
+   *         required: true
+   *         type: string
+   *     responses:
+   *       200:
+   *         description: users
+   */
+  app.post('/users', function(req, res) {
+    res.json(req.body);
+  });
+
+};

lib/index.js

@@ -64,6 +64,27 @@ function filterJsDocComments(jsDocComments) {
   return swaggerJsDocComments;
 }
 
+/**
+ * Merges two objects
+ * @function
+ * @param {object} obj1 - Object 1
+ * @param {object} obj2 - Object 2
+ * @returns {object} Merged Object
+ */
+function objectMerge(obj1, obj2) {
+  var obj3 = {};
+  for (var attr in obj1) {
+    if (obj1.hasOwnProperty(attr)) {
+      obj3[attr] = obj1[attr];
+    }
+  }
+  for (var name in obj2) {
+    if (obj2.hasOwnProperty(name)) {
+      obj3[name] = obj2[name];
+    }
+  }
+  return obj3;
+}
 
 /**
  * Adds the data in the Swagger JSDoc comments to the swagger object.
@@ -78,12 +99,13 @@ function addDataToSwaggerObject(swaggerObject, swaggerJsDocComments) {
 
     for (var j = 0; j < propertyNames.length; j = j + 1) {
       var propertyName = propertyNames[j];
-      swaggerObject.paths[propertyName] = pathObject[propertyName];
+      swaggerObject.paths[propertyName] = objectMerge(
+        swaggerObject.paths[propertyName], pathObject[propertyName]
+      );
     }
   }
 }
 
-
 /**
  * Generates the swagger spec
  * @function

test/swagger-spec.json

@@ -46,6 +46,39 @@
           }
         }
       }
+    },
+    "/users": {
+      "get": {
+        "description": "Returns users",
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "users"
+          }
+        }
+      },
+      "post": {
+        "description": "Returns users",
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "name": "username",
+            "description": "username for user",
+            "in": "formData",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "users"
+          }
+        }
+      }
     }
   }
-}
+}

test/test.js

@@ -66,4 +66,4 @@ describe('swagger spec', function() {
       });
   });
 
-});
+});