Support for a list of files in a multipart/form-data request (#2)

Please note that this is currently not specified and it may be the case that this changes in a future version of the specification.

An upload can be handled with the following definition:
- name: files
  in: formData
  description: Upload multiple files
  required: true
  type: array
  items:
    type: File
  collectionFormat: multi

Relates to: OAI/OpenAPI-Specification#254

Author: akkie

clientstub/src/main/scala/com/mohiva/swagger/codegen/TestApi.scala

@@ -303,14 +303,23 @@ class TestApi @Inject() (apiInvoker: ApiInvoker) {
   /**
    * Test if a request with multipart form data will be sent successfully.
    */
-  def testRequestWithMultipartFormData(file: File, returnFile: Boolean, rc: Config = Config())(
-    implicit
-    ec: ExecutionContext): Future[ApiResponse[File]] = {
-
-    apiInvoker.execute[File](ApiRequest(RequestMethod.POST, "", "/test", Some("multipart/form-data; charset=utf-8"), rc)
+  def testRequestWithMultipartFormData(
+    file: File,
+    files: Seq[File],
+    param: String,
+    returnFile: Boolean,
+    rc: Config = Config()
+  )(
+    implicit
+    ec: ExecutionContext
+  ): Future[ApiResponse[String]] = {
+
+    apiInvoker.execute[String](ApiRequest(RequestMethod.POST, "", "/test", Some("multipart/form-data; charset=utf-8"), rc)
       .withFormParam("file", file)
+      .withFormParam("files", ApiParams.ArrayValues(files, ApiParams.CollectionFormats.MULTI))
+      .withFormParam("param", param)
       .withFormParam("returnFile", returnFile)
-      .withPrimitiveSuccessResponse[File](200)
+      .withPrimitiveSuccessResponse[String](200)
     )
   }
 
@@ -918,4 +927,4 @@ object TestApi {
     def `x-Double`(index: Int = 0) = ApiHeaderExtractor(r.headers).asDouble("X-DOUBLE", index)
     def `x-Boolean`(index: Int = 0) = ApiHeaderExtractor(r.headers).asBoolean("X-BOOLEAN", index)
   }
-}
+}

clientstub/src/main/scala/com/mohiva/swagger/codegen/core/ApiImplicits.scala

@@ -134,7 +134,11 @@ object ApiParams {
   implicit class AnyMapNormalizers(val m: Map[String, Any]) {
     def normalize: Seq[(String, Any)] = m.mapValues(_.normalize).toSeq.flatMap {
       case (name, EmptyValue(_)) => Seq()
-      case (name, ArrayValues(values, format)) if format == CollectionFormats.MULTI => values.map { v => name -> v }
+      case (name, ArrayValues(values, format)) if format == CollectionFormats.MULTI =>
+        m.values.exists(_.isInstanceOf[File]) match {
+          case false => values.map { v => name -> v }
+          case true => values.zipWithIndex.map { case (v, i) => name + i.toString -> v }
+        }
       case (k, v) => Seq(k -> v)
     }
   }

clientstub/src/test/resources/test1.txt

@@ -0,0 +1 @@
+TEST

clientstub/src/test/resources/test2.txt

@@ -0,0 +1 @@
+TEST

clientstub/src/test/resources/test3.txt

@@ -0,0 +1 @@
+TEST

clientstub/src/test/scala/com/mohiva/swagger/codegen/TestApiSpec.scala

@@ -273,16 +273,21 @@ class TestApiSpec extends Specification with NoLanguageFeatures with ContentMatc
     "send a request with multipart-form data" in new WithApplication with Context {
       val route = Route {
         case ("POST", "/test") => Action(parse.multipartFormData) { request =>
-          val file = request.body.file("file")
-          val returnFile = request.body.dataParts.get("returnFile").exists(_.exists(_ == "true"))
-          file -> returnFile match {
-            case (Some(f), true) => Ok.sendFile(f.ref.file)
-            case _ => NoContent
-          }
+          val file1 = request.body.file("file").map(_.filename).getOrElse(throw new Exception("Not found `file`"))
+          val file2 = request.body.file("files0").map(_.filename).getOrElse(throw new Exception("Not found `files0`"))
+          val file3 = request.body.file("files1").map(_.filename).getOrElse(throw new Exception("Not found `files1`"))
+          val param = request.body.dataParts("param").mkString("")
+          val returnFile = request.body.dataParts("returnFile").mkString("")
+          Ok(file1 + "-" + file2 + "-" + file3 + "-" + param + "-" + returnFile)
         }
       }
 
-      await(testApi.testRequestWithMultipartFormData(file("test.txt"), returnFile = true)).content must haveSameLinesAs(file("test.txt"))
+      await(testApi.testRequestWithMultipartFormData(
+        file("test1.txt"),
+        Seq(file("test2.txt"), file("test3.txt")),
+        "test",
+        returnFile = true
+      )).content must be equalTo "test1.txt-test2.txt-test3.txt-test-true"
     }
 
     "send a request with form-url-encoded data" in new Context {