added deduplication of operationIds per swagger-api#595

Author: fehguy

browser/swagger-client.js

@@ -335,6 +335,7 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
       }
 
       var operationId = self.idFromOp(path, method, operation);
+
       var operationObject = new Operation(self,
         operation.scheme,
         operationId,
@@ -388,6 +389,8 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
           self.apisArray.push(new OperationGroup(tag, operationGroup.description, operationGroup.externalDocs, operationObject));
         }
 
+        operationId = self.makeUniqueOperationId(operationId, self.apis[apiProperty]);
+
         // Bind tag help
         if (!_.isFunction(operationGroup.help)) {
           operationGroup.help = _.bind(self.help, operationGroup);
@@ -432,6 +435,28 @@ SwaggerClient.prototype.buildFromSpec = function (response) {
   return this;
 };
 
+SwaggerClient.prototype.makeUniqueOperationId = function(operationId, api) {
+  var count = 0;
+  var name = operationId;
+
+  // make unique across this operation group
+  while(true) {
+    var matched = false;
+    _.forEach(api.operations, function (operation) {
+      if(operation.nickname === name) {
+        matched = true;
+      }
+    })
+    if(!matched) {
+      return name;
+    }
+    name = operationId + '_' + count;
+    count ++;
+  }
+
+  return operationId;
+}
+
 SwaggerClient.prototype.parseUri = function (uri) {
   var urlParseRE = /^(((([^:\/#\?]+:)?(?:(\/\/)((?:(([^:@\/#\?]+)(?:\:([^:@\/#\?]+))?)@)?(([^:\/#\?\]\[]+|\[[^\/\]@#?]+\])(?:\:([0-9]+))?))?)?)?((\/?(?:[^\/\?#]+\/+)*)([^\?#]*)))?(\?[^#]+)?)(#.*)?/;
   var parts = urlParseRE.exec(uri);
@@ -488,6 +513,7 @@ SwaggerClient.prototype.idFromOp = function (path, httpMethod, op) {
   opId = opId.replace(/((_){2,})/g, '_');
   opId = opId.replace(/^(_)*/g, '');
   opId = opId.replace(/([_])*$/g, '');
+
   return opId;
 };
 

browser/swagger-client.min.js

@@ -377,7 +377,6 @@ describe('SwaggerClient', function () {
       usePromise: true
     }).then(function(client) {
       var param = client.test.apis.myop.parameters[0];
-      console.log(param['enum']);
       expect(param.enum).toBe(undefined);
       expect(param.items.enum).toEqual(['a', 'b']);
       done();
@@ -386,7 +385,6 @@ describe('SwaggerClient', function () {
     });
   });
 
-
   it('tests https://github.com/swagger-api/swagger-js/issues/535', function(done) {
     var spec = {
       paths: {
@@ -441,4 +439,46 @@ describe('SwaggerClient', function () {
       done(exception);
     });
   });
+
+
+  it('creates unique operationIds per #595', function(done) {
+    var spec = {
+      paths: {
+        '/foo': {
+          get: {
+            operationId: 'test',
+            parameters: [],
+            responses: {
+              'default': {
+                description: 'success'
+              }
+            }
+          }
+        },
+        '/bar': {
+          get: {
+            operationId: 'test',
+            parameters: [],
+            responses: {
+              'default': {
+                description: 'success'
+              }
+            }
+          }
+        }
+      }
+    };
+
+    new SwaggerClient({
+      url: 'http://example.com/petstore.yaml',
+      spec: spec,
+      usePromise: true
+    }).then(function(client) {
+      expect(client.default.test).toBeA('function');
+      expect(client.default.test_0).toBeAn('function');
+      done();
+    }).catch(function(exception) {
+      done(exception);
+    });
+  });
 });

lib/client.js

@@ -43,11 +43,11 @@ describe('client macros', function () {
             usePromise: true,
             parameterMacro: macros.parameter
         }).then(function(client) {
-            var parameters = client.pet.apis.getPetById.parameters;
-            expect(parameters[0].default).toBe('100');
-            done();
-        }).catch(function(exception) {
-            done(exception);
-        });
+                var parameters = client.pet.apis.getPetById.parameters;
+                expect(parameters[0].default).toBe('100');
+                done();
+            }).catch(function(exception) {
+                done(exception);
+            });
     });
 });

test/client.js

@@ -1083,7 +1083,8 @@ describe('swagger resolver', function () {
       'definitions' : { }
     };
     api.resolve(spec, 'http://localhost:8000/v2/swagger.json', function (spec, unresolved) {
-      console.log(JSON.stringify(spec, null, 2));
+      expect(spec.definitions).toBeAn('object');
+      expect(spec.definitions.inline_model).toBeAn('object');
       done();
     });
   });

test/macros.js

@@ -18,7 +18,7 @@
           "summary": "Find pet by ID",
           "notes": "Returns a pet based on ID",
           "type": "Animals",
-          "nickname": "getPetById",
+          "nickname": "getAnimalsById",
           "authorizations": {},
           "parameters": [
             {