Add support for multiple form files (#34)

* Add support for IFormFile[] / List<FormFile>

* Add support for form file binding parameters, add tests

* nit: unnecessary namespace

* nit: whitespace

* Make changes based on feedback

* Fix another case of over-prescribing type

* Revert unneded changes

---------

Co-authored-by: Oleksandr Liakhevych <[email protected],m>

Author: danielcrenna

GenerateAspNetCoreClient.Command/ClientModelBuilder.cs

@@ -150,12 +150,13 @@ private List<Parameter> GetParameters(ApiDescription apiDescription)
             for (int i = 0; i < apiDescription.ParameterDescriptions.Count; i++)
             {
                 var parameterDescription = apiDescription.ParameterDescriptions[i];
+                var paramType = parameterDescription.ParameterDescriptor?.ParameterType;
 
-                if (parameterDescription.ParameterDescriptor?.ParameterType == typeof(CancellationToken))
+                if (paramType == typeof(CancellationToken))
                     continue;
 
                 // IFormFile
-                if (parameterDescription.ParameterDescriptor?.ParameterType == typeof(IFormFile))
+                if (paramType == typeof(IFormFile))
                 {
                     var name = parameterDescription.ParameterDescriptor.Name;
 
@@ -177,12 +178,30 @@ private List<Parameter> GetParameters(ApiDescription apiDescription)
                     continue;
                 }
 
+                // IEnumerable<IFormFile>
+                if (paramType != null)
+                {
+                    if (typeof(IEnumerable<IFormFile>).IsAssignableFrom(paramType))
+                    {
+                        var name = parameterDescription.ParameterDescriptor?.Name;
+
+                        parametersList.Add(new Parameter(
+                            source: ParameterSource.File,
+                            type: typeof(List<Stream>),
+                            name: parameterDescription.Name,
+                            parameterName: name?.ToCamelCase() ?? "files",
+                            defaultValueLiteral: null));
+
+                        continue;
+                    }
+                }
+
                 // Form
                 // API explorer shows form as separate parameters. We want to have single model parameter.
                 if (parameterDescription.Source == BindingSource.Form)
                 {
                     var name = parameterDescription.ParameterDescriptor?.Name ?? "form";
-                    var formType = parameterDescription.ParameterDescriptor?.ParameterType ?? typeof(object);
+                    var formType = paramType ?? typeof(object);
 
                     if (formType == typeof(IFormCollection))
                     {
@@ -202,7 +221,7 @@ private List<Parameter> GetParameters(ApiDescription apiDescription)
                             .ToArray();
 
                         // If form model has file parameters - we have to put it as separate parameters.
-                        if (!sameFormParameters.Any(p => p.Source.Id == "FormFile"))
+                        if (sameFormParameters.All(p => p.Source.Id != "FormFile"))
                         {
                             parametersList.Add(new Parameter(
                                 source: ParameterSource.Form,
@@ -274,11 +293,19 @@ private List<Parameter> GetParameters(ApiDescription apiDescription)
                     ? parameterDescription.Name.ToCamelCase()
                     : (parameterDescription.ParameterDescriptor?.Name ?? parameterDescription.Name).ToCamelCase();
 
-                parameterName = new string(parameterName.Where(c => char.IsLetterOrDigit(c)).ToArray());
+                parameterName = new string(parameterName.Where(char.IsLetterOrDigit).ToArray());
 
-                var type = parameterDescription.Source == BindingSource.FormFile
-                    ? typeof(Stream)
-                    : parameterDescription.ModelMetadata?.ModelType ?? parameterDescription.Type ?? typeof(string);
+                Type type;
+                if (parameterDescription.Source == BindingSource.FormFile)
+                {
+                    type = typeof(IEnumerable<IFormFile>).IsAssignableFrom(parameterDescription.Type)
+                        ? typeof(List<Stream>)
+                        : typeof(Stream);
+                }
+                else
+                {
+                    type = parameterDescription.ModelMetadata?.ModelType ?? parameterDescription.Type;
+                }
 
                 var defaultValue = GetDefaultValueLiteral(parameterDescription, type);
 

GenerateAspNetCoreClient.Command/GenerateClientCommand.cs

@@ -81,7 +81,17 @@ private static string CreateClient(Client clientModel, HashSet<Type> ambiguousTy
                             _ => ""
                         };
 
-                        var type = p.Source == ParameterSource.File ? "MultipartItem" : p.Type.GetName(ambiguousTypes);
+                        string type;
+                        if (p.Source == ParameterSource.File)
+                        {
+                            bool isEnumerable = p.Type != typeof(string) && typeof(IEnumerable).IsAssignableFrom(p.Type);
+                            type = isEnumerable ? "List<MultipartItem>" : "MultipartItem";
+                        }
+                        else
+                        {
+                            type = p.Type.GetName(ambiguousTypes);
+                        }
+
                         var defaultValue = p.DefaultValueLiteral == null ? "" : " = " + p.DefaultValueLiteral;
                         return $"{attribute}{type} {p.ParameterName}{defaultValue}";
                     })

Tests/GenerateAspNetCoreClient.Tests/__snapshots__/TestWebApi.Controllers/IWeatherForecastApi.cs.snap

@@ -24,6 +24,10 @@ namespace Test.Name.Space
         [Post("/WeatherForecast/upload")]
         Task Upload(MultipartItem uploadedFile);
 
+        [Multipart]
+        [Post("/WeatherForecast/upload-multiple")]
+        Task Upload(List<MultipartItem> uploadedFiles);
+
         [Get("/WeatherForecast/download")]
         Task<Stream> Download();
 
@@ -46,6 +50,10 @@ namespace Test.Name.Space
         [Post("/WeatherForecast/form-with-file")]
         Task WithFormWithFileParam(string queryParam = null, MultipartItem formParam = null, string title = null);
 
+        [Multipart]
+        [Post("/WeatherForecast/form-with-files")]
+        Task WithFormWithFilesParam(string queryParam = null, List<MultipartItem> formParam = null, string title = null);
+
         [Get("/WeatherForecast/record")]
         Task<RecordModel> WithRecordModels(Guid? id = null, string name = null);
     }

Tests/TestWebApi.Controllers/Controllers/WeatherForecastController.cs

@@ -62,6 +62,12 @@ public Task Upload(IFormFile uploadedFile)
         return null;
     }
 
+    [HttpPost("upload-multiple")]
+    public Task Upload(List<IFormFile> uploadedFiles)
+    {
+        return null;
+    }
+
     [HttpGet("download")]
     public Task<FileContentResult> Download()
     {
@@ -109,6 +115,13 @@ public async Task<ActionResult> WithFormWithFileParam([FromQuery] string queryPa
         return Ok();
     }
 
+    [HttpPost("form-with-files")]
+    public async Task<ActionResult> WithFormWithFilesParam([FromQuery] string queryParam, [FromForm] FormModelWithMultipleFiles formParam)
+    {
+        await Task.Delay(1);
+        return Ok();
+    }
+
     [HttpGet("record")]
     public async Task<ActionResult<RecordModel>> WithRecordModels([FromQuery] RecordModel record)
     {
@@ -118,4 +131,6 @@ public async Task<ActionResult<RecordModel>> WithRecordModels([FromQuery] Record
 }
 
 
-public record FormModelWithFile(IFormFile File, string Title);
+public record FormModelWithFile(IFormFile File, string Title);
+
+public record FormModelWithMultipleFiles(IFormFile[] Files, string Title);