Support for form data parameters (C#), v2.18

Author: RicoSuter

src/NSwag.Annotations/Properties/AssemblyInfo.cs

@@ -5,4 +5,4 @@
 [assembly: AssemblyCompany("Rico Suter")]
 [assembly: AssemblyProduct("NSwag.Annotations")]
 [assembly: AssemblyCopyright("Copyright © Rico Suter, 2015")]
-[assembly: AssemblyVersion("2.17.*")]
+[assembly: AssemblyVersion("2.18.*")]

src/NSwag.CodeGeneration.Tests/ClientGeneration/ArrayParameterTests.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
@@ -71,9 +70,11 @@ public void When_parameter_is_array_then_TypeScript_is_correct()
             var settings = new SwaggerToTypeScriptClientGeneratorSettings { ClassName = "MyClass" };
             var generator = new SwaggerToTypeScriptClientGenerator(service, settings);
             var code = generator.GenerateFile();
-            
+
             //// Assert
-            Assert.IsTrue(code.Contains(@"elementId.forEach(item => { url += ""elementId="" + encodeURIComponent("""" + item) + ""&""; });"));
+            Assert.IsTrue(
+                code.Contains(
+                    @"elementId.forEach(item => { url += ""elementId="" + encodeURIComponent("""" + item) + ""&""; });"));
         }
 
         [TestMethod]
@@ -137,7 +138,10 @@ public void When_parameter_is_array_then_CSharp_is_correct()
             var code = generator.GenerateFile();
 
             //// Assert
-            Assert.IsTrue(code.Contains(@"foreach(var item_ in elementId) { url_ += string.Format(""elementId={0}&"", Uri.EscapeUriString(item_.ToString())); }"));
+            Assert.IsTrue(
+                code.Contains(
+                    @"foreach(var item_ in elementId) { url_ += string.Format(""elementId={0}&"", Uri.EscapeUriString(item_.ToString())); }"));
         }
+
     }
 }

src/NSwag.CodeGeneration.Tests/ClientGeneration/FormParameterTests.cs

@@ -0,0 +1,55 @@
+using System.Collections.Generic;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using NJsonSchema;
+using NSwag.CodeGeneration.CodeGenerators.CSharp;
+
+namespace NSwag.CodeGeneration.Tests.ClientGeneration
+{
+    [TestClass]
+    public class FormParameterTests
+    {
+        [TestMethod]
+        public void When_form_parameters_are_defined_then_MultipartFormDataContent_is_generated()
+        {
+            //// Arrange
+            var service = new SwaggerService();
+            service.Paths["foo/bar"] = new SwaggerOperations
+            {
+                {
+                    SwaggerOperationMethod.Post,
+                    new SwaggerOperation
+                    {
+                        Parameters = new List<SwaggerParameter>
+                        {
+                            new SwaggerParameter
+                            {
+                                Name = "foo",
+                                Kind = SwaggerParameterKind.FormData,
+                                Type = JsonObjectType.String
+                            },
+                            new SwaggerParameter
+                            {
+                                Name = "bar",
+                                IsRequired = true,
+                                Kind = SwaggerParameterKind.FormData,
+                                Type = JsonObjectType.String
+                            }
+                        }
+                    }
+                }
+            };
+
+            //// Act
+            var generator = new SwaggerToCSharpClientGenerator(service, new SwaggerToCSharpClientGeneratorSettings
+            {
+
+            });
+            var code = generator.GenerateFile();
+
+            //// Assert
+            Assert.IsTrue(code.Contains("new MultipartFormDataContent"));
+            Assert.IsTrue(code.Contains("if (foo != null)"));
+            Assert.IsTrue(code.Contains("throw new ArgumentNullException(\"bar\");"));
+        }
+    }
+}

src/NSwag.CodeGeneration.Tests/NSwag.CodeGeneration.Tests.csproj

@@ -78,6 +78,7 @@
   </Choose>
   <ItemGroup>
     <Compile Include="ClientGeneration\ArrayParameterTests.cs" />
+    <Compile Include="ClientGeneration\FormParameterTests.cs" />
     <Compile Include="CodeGenerationTests.cs" />
     <Compile Include="CommandLine\WebApiCommandLineTests.cs" />
     <Compile Include="OperationNameGenerator\MultipleClientsFromOperationIdOperationNameGeneratorTests.cs" />

src/NSwag.CodeGeneration.Tests/Properties/AssemblyInfo.cs

@@ -31,6 +31,6 @@
 //
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
-// [assembly: AssemblyVersion("2.17.*")]
+// [assembly: AssemblyVersion("2.18.*")]
 [assembly: AssemblyVersion("1.0.0.0")]
 [assembly: AssemblyFileVersion("1.0.0.0")]

src/NSwag.CodeGeneration/CodeGenerators/CSharp/Templates/Client.txt

@@ -105,7 +105,22 @@ public partial class <class> <if(hasBaseType)>: <endif><if(hasBaseClass)><baseCl
     <if(operation.IsGetOrDelete)>
         var response_ = await client_.<operation.HttpMethodUpper>Async(url_, cancellationToken).ConfigureAwait(false);
     <else>
-        var response_ = await client_.<operation.HttpMethodUpper>Async(url_, new StringContent(string.Empty), cancellationToken).ConfigureAwait(false);
+        <if(operation.HasFormParameters)>
+        var content_ = new MultipartFormDataContent();
+<operation.FormParameters:{parameter |
+    <if(parameter.IsOptional)>
+        if (<parameter.VariableNameLower> != null)
+    <else>
+        if (<parameter.VariableNameLower> == null)
+            throw new ArgumentNullException("<parameter.VariableNameLower>");
+        else
+    <endif>
+            content_.Add(new StringContent(<parameter.VariableNameLower>.ToString()), "<parameter.Name>");
+}>
+        <else>
+        var content_ = new StringContent(string.Empty);
+        <endif>
+        var response_ = await client_.<operation.HttpMethodUpper>Async(url_, content_, cancellationToken).ConfigureAwait(false);
     <endif>
         ProcessResponse(client_, response_);
 <endif>

src/NSwag.CodeGeneration/CodeGenerators/ClientGeneratorBase.cs

@@ -94,6 +94,7 @@ internal List<OperationModel> GetOperations<TGenerator>(SwaggerService service,
                         HasResultType = HasResultType(operation),
                         ResultDescription = GetResultDescription(operation),
                         ExceptionType = GetExceptionType(operation),
+                        HasFormParameters = operation.Parameters.Any(p => p.Kind == SwaggerParameterKind.FormData),
                         Responses = responses,
                         DefaultResponse = defaultResponse,
                         Parameters = operation.Parameters.Select(p =>

src/NSwag.CodeGeneration/CodeGenerators/Models/OperationModel.cs

@@ -64,10 +64,14 @@ internal class OperationModel
 
         public IEnumerable<ParameterModel> HeaderParameters => Parameters.Where(p => p.Kind == SwaggerParameterKind.Header);
 
+        public IEnumerable<ParameterModel> FormParameters => Parameters.Where(p => p.Kind == SwaggerParameterKind.FormData);
+
         public string Summary => ConversionUtilities.RemoveWhiteSpaces(Operation.Summary);
 
         public bool HasSummary => !string.IsNullOrEmpty(Summary);
 
         public bool HasDocumentation => HasSummary || HasResultDescription || Parameters.Any(p => p.HasDescription);
+
+        public bool HasFormParameters { get; set; }
     }
 }

src/NSwag.CodeGeneration/Infrastructure/AppDomainIsolation.cs

@@ -16,7 +16,7 @@ internal sealed class AppDomainIsolation<T> : IDisposable where T : MarshalByRef
         public AppDomainIsolation(string assemblyDirectory, string assemblyConfiguration)
         {
             if (string.IsNullOrEmpty(assemblyDirectory))
-                throw new ArgumentNullException("assemblyDirectory");
+                throw new ArgumentNullException(nameof(assemblyDirectory));
 
             using (var transformer = new AssemblyConfigurationFileTransformer())
             {

src/NSwag.CodeGeneration/Infrastructure/AssemblyConfigurationFileTransformer.cs

@@ -16,7 +16,7 @@ namespace NSwag.CodeGeneration.Infrastructure
 {
     internal class AssemblyConfigurationFileTransformer : IDisposable
     {
-        private string _transformedConfiguationPath = null;
+        private string _transformedConfigurationPath = null;
 
         public string GetConfigurationPath(string assemblyDirectory)
         {
@@ -32,7 +32,7 @@ public string GetConfigurationPath(string assemblyDirectory)
                     RegexOptions.Singleline);
 
                 File.WriteAllText(configPath, content, Encoding.UTF8);
-                _transformedConfiguationPath = configPath;
+                _transformedConfigurationPath = configPath;
                 return configPath;
             }
 
@@ -41,10 +41,10 @@ public string GetConfigurationPath(string assemblyDirectory)
 
         public void Dispose()
         {
-            if (_transformedConfiguationPath != null)
+            if (_transformedConfigurationPath != null)
             {
-                File.Delete(_transformedConfiguationPath);
-                _transformedConfiguationPath = null; 
+                File.Delete(_transformedConfigurationPath);
+                _transformedConfigurationPath = null; 
             }
         }