add authentication support

Author: wing328

modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache

@@ -8,26 +8,41 @@ using Newtonsoft.Json;
 using RestSharp;
 
 namespace {{invokerPackage}} {
+  /// <summary>
+  /// API client is mainly responible for making the HTTP call to the API backend
+  /// </summary>
   public class ApiClient {
-    public ApiClient() {
-      this.basePath = "{{basePath}}";
-      this.restClient = new RestClient(this.basePath);
-    }
 
-    public ApiClient(String basePath) {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ApiClient"/> class.
+    /// </summary>
+    /// <param name="basePath">The base path.</param>
+    public ApiClient(String basePath="{{basePath}}") {
       this.basePath = basePath;
       this.restClient = new RestClient(this.basePath);
     }
 
+    /// <summary>
+    /// Gets or sets the base path.
+    /// </summary>
+    /// <value>The base path.</value> 
     public string basePath { get; set; }
+
+    /// <summary>
+    /// Gets or sets the RestClient
+    /// </summary>
+    /// <value>The RestClient.</value> 
     public RestClient restClient { get; set; }
+
     private Dictionary<String, String> defaultHeaderMap = new Dictionary<String, String>();
 
     public Object CallApi(String Path, RestSharp.Method Method, Dictionary<String, String> QueryParams, String PostBody, 
-      Dictionary<String, String> HeaderParams, Dictionary<String, String> FormParams, Dictionary<String, String> FileParams) {
+      Dictionary<String, String> HeaderParams, Dictionary<String, String> FormParams, Dictionary<String, String> FileParams, String[] AuthSettings) {
 
       var request = new RestRequest(Path, Method);
 
+      UpdateParamsForAuth(QueryParams, HeaderParams, AuthSettings);
+
       // add default header, if any
       foreach(KeyValuePair<string, string> defaultHeader in this.defaultHeaderMap)
         request.AddHeader(defaultHeader.Key, defaultHeader.Value);
@@ -126,5 +141,59 @@ namespace {{invokerPackage}} {
         throw new ApiException(500, e.Message);
       }
     }
+
+    /// <summary>
+    /// Get the API key with prefix
+    /// </summary>
+    /// <param name="obj"> Object 
+    /// <returns>API key with prefix</returns>
+    public string GetApiKeyWithPrefix (string apiKey)
+    {
+      var apiKeyValue = "";
+      Configuration.apiKey.TryGetValue (apiKey, out apiKeyValue);
+      var apiKeyPrefix = "";
+      if (Configuration.apiKeyPrefix.TryGetValue (apiKey, out apiKeyPrefix)) {
+        return apiKeyPrefix + " " + apiKeyValue;
+      } else {
+        return apiKeyValue;
+      }
+    }
+
+    /// <summary>
+    /// Update parameters based on authentication
+    /// </summary>
+    /// <param name="QueryParams">Query parameters</param>
+    /// <param name="HeaderParams">Header parameters</param>
+    /// <param name="AuthSettings">Authentication settings</param>
+    public void UpdateParamsForAuth(Dictionary<String, String> QueryParams, Dictionary<String, String> HeaderParams, string[] AuthSettings) {
+      if (AuthSettings == null || AuthSettings.Length == 0)
+        return;
+  
+      foreach (string auth in AuthSettings) {
+        // determine which one to use
+        switch(auth) {
+          {{#authMethods}}
+          case "{{name}}":
+            {{#isApiKey}}{{#isKeyInHeader}}HeaderParams["{{keyParamName}}"] = GetApiKeyWithPrefix("{{keyParamName}}");{{/isKeyInHeader}}{{#isKeyInQuery}}QueryParams["{{keyParamName}}"] = GetApiKeyWithPrefix("{{keyParamName}}");{{/isKeyInQuery}}{{/isApiKey}}{{#isBasic}}HeaderParams["Authorization"] = "Basic " + Base64Encode(Configuration.username + ":" + Configuration.password);{{/isBasic}}
+            {{#isOAuth}}//TODO support oauth{{/isOAuth}}
+            break;
+          {{/authMethods}}
+          default:
+            //TODO show warning about security definition not found
+          break;
+        }
+      }
+
+    }
+
+    /// <summary>
+    /// Encode string in base64 format 
+    /// </summary>
+    /// <param name="text">String to be encoded</param>
+    public static string Base64Encode(string text) {
+      var textByte = System.Text.Encoding.UTF8.GetBytes(text);
+      return System.Convert.ToBase64String(textByte);
+    }
+
   }
 }

modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache

@@ -7,8 +7,41 @@ using System.Text;
 using {{invokerPackage}};
 
 namespace {{invokerPackage}} {
+  /// <summary>
+  /// Represents a set of configuration settings
+  /// </summary>
   public class Configuration{
+
+    /// <summary>
+    /// Gets or sets the API client. This is the default API client for making HTTP calls.
+    /// </summary>
+    /// <value>The API client.</value>
     public static ApiClient apiClient = new ApiClient();
 
+    /// <summary>
+    /// Gets or sets the username (HTTP basic authentication)
+    /// </summary>
+    /// <value>The username.</value>
+    public static String username { get; set; }
+
+    /// <summary>
+    /// Gets or sets the password (HTTP basic authentication)
+    /// </summary>
+    /// <value>The password.</value>
+    public static String password { get; set; }
+
+    /// <summary>
+    /// Gets or sets the API key based on the authentication name 
+    /// </summary>
+    /// <value>The API key.</value>
+    public static Dictionary<String, String> apiKey = new Dictionary<String, String>();
+
+    /// <summary>
+    /// Gets or sets the prefix (e.g. Token) of the API key based on the authentication name 
+    /// </summary>
+    /// <value>The prefix of the API key.</value>
+    public static Dictionary<String, String> apiKeyPrefix = new Dictionary<String, String>();
+
+
   }
 }

modules/swagger-codegen/src/main/resources/csharp/api.mustache

@@ -8,20 +8,14 @@ using {{modelPackage}};
 
 namespace {{package}} {
   {{#operations}}
+  /// <summary>
+  /// Represents a collection of functions to interact with the API endpoints
+  /// </summary>
   public class {{classname}} {
-    string basePath;
-    public ApiClient apiClient {get; set;}
-
-    public {{classname}}(String basePath = "{{basePath}}")
-    {
-      this.basePath = basePath;
-      this.apiClient = new ApiClient(basePath);
-    }
-
     /// <summary>
-    /// Create a new object 
+    /// Initializes a new instance of the <see cref="{{classname}}"/> class.
     /// </summary>
-    /// <param name="apiClient"> an instance of ApiClient
+    /// <param name="apiClient"> an instance of ApiClient (optional)
     /// <returns></returns>
     public {{classname}}(ApiClient apiClient = null) {
       if (apiClient == null) { // use the default one in Configuration
@@ -32,22 +26,37 @@ namespace {{package}} {
     }
 
     /// <summary>
-    /// Sets the endpoint base url for the services being accessed
+    /// Initializes a new instance of the <see cref="{{classname}}"/> class.
     /// </summary>
-    /// <param name="basePath"> Base URL
     /// <returns></returns>
-    public void SetBasePath(string basePath) {
-      this.basePath = basePath;
+    public {{classname}}(String basePath)
+    {
+      this.apiClient = new ApiClient(basePath);
+    }
+
+    /// <summary>
+    /// Sets the base path of the API client.
+    /// </summary>
+    /// <value>The base path</value>
+    public void SetBasePath(String basePath) {
+      this.apiClient.basePath = basePath;
     }
 
     /// <summary>
-    /// Gets the endpoint base url for the services being accessed
-    /// <returns>Base URL</returns>
+    /// Gets the base path of the API client.
     /// </summary>
-    public String GetBasePath() {
-      return this.basePath;
+    /// <value>The base path</value>
+    public String GetBasePath(String basePath) {
+      return this.apiClient.basePath;
     }
 
+    /// <summary>
+    /// Gets or sets the API client.
+    /// </summary>
+    /// <value>The API client</value>
+    public ApiClient apiClient {get; set;}
+
+
     {{#operation}}
     /// <summary>
     /// {{summary}} {{notes}}
@@ -82,8 +91,11 @@ namespace {{package}} {
       {{#bodyParam}}postBody = apiClient.Serialize({{paramName}}); // http body (model) parameter
       {{/bodyParam}}
 
+      // authentication setting, if any
+      String[] authSettings = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
+
       // make the HTTP request
-      IRestResponse response = (IRestResponse) apiClient.CallApi(path, Method.{{httpMethod}}, queryParams, postBody, headerParams, formParams, fileParams);
+      IRestResponse response = (IRestResponse) apiClient.CallApi(path, Method.{{httpMethod}}, queryParams, postBody, headerParams, formParams, fileParams, authSettings);
 
       if (((int)response.StatusCode) >= 400) {
         throw new ApiException ((int)response.StatusCode, "Error calling {{nickname}}: " + response.Content);

modules/swagger-codegen/src/main/resources/csharp/apiException.mustache

@@ -1,13 +1,27 @@
 using System;
 
 namespace {{invokerPackage}} {
-
+  /// <summary>
+  /// API Exception
+  /// </summary>
   public class ApiException : Exception {
-
+    /// <summary>
+    /// Gets or sets the error code (HTTP status code)
+    /// </summary>
+    /// <value>The error code (HTTP status code).</value>
     public int ErrorCode { get; set; }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ApiException"/> class.
+    /// </summary>
+    /// <param name="basePath">The base path.</param>
     public ApiException() {}
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ApiException"/> class.
+    /// </summary>
+    /// <param name="errorCode">HTTP status code.</param>
+    /// <param name="message">Error message.</param>
     public ApiException(int errorCode, string message) : base(message) {
       this.ErrorCode = errorCode;
     }

modules/swagger-codegen/src/main/resources/csharp/model.mustache

@@ -3,10 +3,15 @@ using System.Text;
 using System.Collections;
 using System.Collections.Generic;
 using System.Runtime.Serialization;
+using Newtonsoft.Json;
 
 {{#models}}
 {{#model}}
 namespace {{package}} {
+
+  /// <summary>
+  /// {{description}}
+  /// </summary>
   [DataContract]
   public class {{classname}} {
     {{#vars}}
@@ -15,6 +20,11 @@ namespace {{package}} {
     public {{{datatype}}} {{name}} { get; set; }
 
     {{/vars}}
+
+    /// <summary>
+    /// Get the string presentation of the object
+    /// </summary>
+    /// <returns>String presentation of the object</returns>
     public override string ToString()  {
       var sb = new StringBuilder();
       sb.Append("class {{classname}} {\n");
@@ -24,7 +34,16 @@ namespace {{package}} {
       sb.Append("}\n");
       return sb.ToString();
     }
-  }
+
+    /// <summary>
+    /// Get the JSON string presentation of the object
+    /// </summary>
+    /// <returns>JSON string presentation of the object</returns>
+    public string ToJson() {
+      return JsonConvert.SerializeObject(this, Formatting.Indented);
+    }
+
+}
   {{/model}}
   {{/models}}
 }