Merge pull request #2056 from xhh/javascript-auth

[JavaScript] Add authentications support to JavaScript client
swagger-api · Feb 16, 2016 · a47cddd · a47cddd
2 parents a87ce31 + 7beb737
commit a47cddd
Show file tree

Hide file tree

Showing 10 changed files with 357 additions and 29 deletions.
diff --git a/modules/swagger-codegen/src/main/resources/Javascript/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/Javascript/ApiClient.mustache
@@ -20,7 +20,13 @@
      * The base path to put in front of every API call's (relative) path.
      */
     this.basePath = '{{basePath}}'.replace(/\/+$/, '');
-
+{{=< >=}}
+    this.authentications = {<#authMethods><#isBasic>
+      '<name>': {type: 'basic'}</isBasic><#isApiKey>
+      '<name>': {type: 'apiKey', in: <#isKeyInHeader>'header'</isKeyInHeader><^isKeyInHeader>'query'</isKeyInHeader>, name: '<keyParamName>'}</isApiKey><#isOAuth>
+      '<name>': {type: 'oauth2'}</isOAuth><#hasMore>,</hasMore></authMethods>
+    };
+<={{ }}=>
     /**
      * The default HTTP headers to be included for all API calls.
      */
@@ -158,6 +164,42 @@
     }
   };
 
+  ApiClient.prototype.applyAuthToRequest = function applyAuthToRequest(request, authNames) {
+    var _this = this;
+    authNames.forEach(function(authName) {
+      var auth = _this.authentications[authName];
+      switch (auth.type) {
+        case 'basic':
+          if (auth.username || auth.password) {
+            request.auth(auth.username || '', auth.password || '');
+          }
+          break;
+        case 'apiKey':
+          if (auth.apiKey) {
+            var data = {};
+            if (auth.apiKeyPrefix) {
+              data[auth.name] = auth.apiKeyPrefix + ' ' + auth.apiKey;
+            } else {
+              data[auth.name] = auth.apiKey;
+            }
+            if (auth.in === 'header') {
+              request.set(data);
+            } else {
+              request.query(data);
+            }
+          }
+          break;
+        case 'oauth2':
+          if (auth.accessToken) {
+            request.set({'Authorization': 'Bearer ' + auth.accessToken});
+          }
+          break;
+        default:
+          throw new Error('Unknown authentication type: ' + auth.type);
+      }
+    });
+  };
+
   ApiClient.prototype.deserialize = function deserialize(response, returnType) {
     if (response == null || returnType == null) {
       return null;
@@ -172,12 +214,15 @@
   };
 
   ApiClient.prototype.callApi = function callApi(path, httpMethod, pathParams,
-      queryParams, headerParams, formParams, bodyParam, contentTypes, accepts,
-      returnType{{^usePromises}}, callback{{/usePromises}}) {
+      queryParams, headerParams, formParams, bodyParam, authNames, contentTypes,
+      accepts, returnType{{^usePromises}}, callback{{/usePromises}}) {
     var _this = this;
     var url = this.buildUrl(path, pathParams);
     var request = superagent(httpMethod, url);
 
+    // apply authentications
+    this.applyAuthToRequest(request, authNames);
+
     // set query parameters
     request.query(this.normalizeParams(queryParams));
 

diff --git a/modules/swagger-codegen/src/main/resources/Javascript/api.mustache b/modules/swagger-codegen/src/main/resources/Javascript/api.mustache
@@ -51,14 +51,15 @@
         '<baseName>': <#collectionFormat>this.buildCollectionParam(<paramName>, '<collectionFormat>')</collectionFormat><^collectionFormat><paramName></collectionFormat><#hasMore>,</hasMore></formParams>
       };
 
+      var authNames = [<#authMethods>'<name>'<#hasMore>, </hasMore></authMethods>];
       var contentTypes = [<#consumes>'<mediaType>'<#hasMore>, </hasMore></consumes>];
       var accepts = [<#produces>'<mediaType>'<#hasMore>, </hasMore></produces>];
       var returnType = <#returnType><&returnType></returnType><^returnType>null</returnType>;
 
       return this.apiClient.callApi(
         '<&path>', '<httpMethod>',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType<^usePromises>, callback</usePromises>
+        authNames, contentTypes, accepts, returnType<^usePromises>, callback</usePromises>
       );
       <={{ }}=>
     }

diff --git a/modules/swagger-codegen/src/main/resources/Javascript/package.mustache b/modules/swagger-codegen/src/main/resources/Javascript/package.mustache
@@ -12,6 +12,7 @@
   },
   "devDependencies": {
     "mocha": "~2.3.4",
+    "sinon": "1.17.3",
     "expect.js": "~0.3.1"
   }
 }
diff --git a/samples/client/petstore/javascript/package.json b/samples/client/petstore/javascript/package.json
@@ -12,6 +12,7 @@
   },
   "devDependencies": {
     "mocha": "~2.3.4",
+    "sinon": "1.17.3",
     "expect.js": "~0.3.1"
   }
 }
diff --git a/samples/client/petstore/javascript/src/ApiClient.js b/samples/client/petstore/javascript/src/ApiClient.js
@@ -21,6 +21,11 @@
      */
     this.basePath = 'http://petstore.swagger.io/v2'.replace(/\/+$/, '');
 
+    this.authentications = {
+      'petstore_auth': {type: 'oauth2'},
+      'api_key': {type: 'apiKey', in: 'header', name: 'api_key'}
+    };
+
     /**
      * The default HTTP headers to be included for all API calls.
      */
@@ -158,6 +163,42 @@
     }
   };
 
+  ApiClient.prototype.applyAuthToRequest = function applyAuthToRequest(request, authNames) {
+    var _this = this;
+    authNames.forEach(function(authName) {
+      var auth = _this.authentications[authName];
+      switch (auth.type) {
+        case 'basic':
+          if (auth.username || auth.password) {
+            request.auth(auth.username || '', auth.password || '');
+          }
+          break;
+        case 'apiKey':
+          if (auth.apiKey) {
+            var data = {};
+            if (auth.apiKeyPrefix) {
+              data[auth.name] = auth.apiKeyPrefix + ' ' + auth.apiKey;
+            } else {
+              data[auth.name] = auth.apiKey;
+            }
+            if (auth.in === 'header') {
+              request.set(data);
+            } else {
+              request.query(data);
+            }
+          }
+          break;
+        case 'oauth2':
+          if (auth.accessToken) {
+            request.set({'Authorization': 'Bearer ' + auth.accessToken});
+          }
+          break;
+        default:
+          throw new Error('Unknown authentication type: ' + auth.type);
+      }
+    });
+  };
+
   ApiClient.prototype.deserialize = function deserialize(response, returnType) {
     if (response == null || returnType == null) {
       return null;
@@ -172,12 +213,15 @@
   };
 
   ApiClient.prototype.callApi = function callApi(path, httpMethod, pathParams,
-      queryParams, headerParams, formParams, bodyParam, contentTypes, accepts,
-      returnType, callback) {
+      queryParams, headerParams, formParams, bodyParam, authNames, contentTypes,
+      accepts, returnType, callback) {
     var _this = this;
     var url = this.buildUrl(path, pathParams);
     var request = superagent(httpMethod, url);
 
+    // apply authentications
+    this.applyAuthToRequest(request, authNames);
+
     // set query parameters
     request.query(this.normalizeParams(queryParams));
 

diff --git a/samples/client/petstore/javascript/src/api/PetApi.js b/samples/client/petstore/javascript/src/api/PetApi.js
@@ -41,14 +41,15 @@
       var formParams = {
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = ['application/json', 'application/xml'];
       var accepts = ['application/json', 'application/xml'];
       var returnType = null;
 
       return this.apiClient.callApi(
         '/pet', 'PUT',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -73,14 +74,15 @@
       var formParams = {
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = ['application/json', 'application/xml'];
       var accepts = ['application/json', 'application/xml'];
       var returnType = null;
 
       return this.apiClient.callApi(
         '/pet', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -107,14 +109,15 @@
       var formParams = {
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = [];
       var accepts = ['application/json', 'application/xml'];
       var returnType = [Pet];
 
       return this.apiClient.callApi(
         '/pet/findByStatus', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -141,14 +144,15 @@
       var formParams = {
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = [];
       var accepts = ['application/json', 'application/xml'];
       var returnType = [Pet];
 
       return this.apiClient.callApi(
         '/pet/findByTags', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -180,14 +184,15 @@
       var formParams = {
       };
 
+      var authNames = ['api_key'];
       var contentTypes = [];
       var accepts = ['application/json', 'application/xml'];
       var returnType = Pet;
 
       return this.apiClient.callApi(
         '/pet/{petId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -222,14 +227,15 @@
         'status': status
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = ['application/x-www-form-urlencoded'];
       var accepts = ['application/json', 'application/xml'];
       var returnType = null;
 
       return this.apiClient.callApi(
         '/pet/{petId}', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -262,14 +268,15 @@
       var formParams = {
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = [];
       var accepts = ['application/json', 'application/xml'];
       var returnType = null;
 
       return this.apiClient.callApi(
         '/pet/{petId}', 'DELETE',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -304,14 +311,15 @@
         'file': file
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = ['multipart/form-data'];
       var accepts = ['application/json', 'application/xml'];
       var returnType = null;
 
       return this.apiClient.callApi(
         '/pet/{petId}/uploadImage', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -343,14 +351,15 @@
       var formParams = {
       };
 
+      var authNames = ['api_key'];
       var contentTypes = [];
       var accepts = ['application/json', 'application/xml'];
       var returnType = 'String';
 
       return this.apiClient.callApi(
         '/pet/{petId}?testing_byte_array=true', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }
@@ -375,14 +384,15 @@
       var formParams = {
       };
 
+      var authNames = ['petstore_auth'];
       var contentTypes = ['application/json', 'application/xml'];
       var accepts = ['application/json', 'application/xml'];
       var returnType = null;
 
       return this.apiClient.callApi(
         '/pet?testing_byte_array=true', 'POST',
         pathParams, queryParams, headerParams, formParams, postBody,
-        contentTypes, accepts, returnType, callback
+        authNames, contentTypes, accepts, returnType, callback
       );
 
     }