zio#2541 Fix bug where the OpenAPI generator fails to generate multip…

…le methods for the same path. (zio#2542) * zio#2541 Fix bug where the OpenAPI generator fails to generate multiple methods for the same path. * Update version in README.
987Nabil · Dec 8, 2023 · 6e230b9 · 6e230b9
1 parent 94f5ec1
commit 6e230b9
Show file tree

Hide file tree

Showing 3 changed files with 104 additions and 3 deletions.
diff --git a/zio-http/src/main/scala/zio/http/endpoint/openapi/OpenAPI.scala b/zio-http/src/main/scala/zio/http/endpoint/openapi/OpenAPI.scala
@@ -81,13 +81,33 @@ final case class OpenAPI(
     openapi = openapi,
     info = info,
     servers = servers ++ other.servers,
-    paths = paths ++ other.paths,
+    paths = mergePaths(paths, other.paths),
     components = (components.toSeq ++ other.components).reduceOption(_ ++ _),
     security = security ++ other.security,
     tags = tags ++ other.tags,
     externalDocs = externalDocs,
   )
 
+  private def mergePaths(paths: Map[OpenAPI.Path, OpenAPI.PathItem]*): Map[OpenAPI.Path, OpenAPI.PathItem] =
+    paths
+      .foldRight[Seq[(OpenAPI.Path, OpenAPI.PathItem)]](Seq.empty)((z, p) => z.toSeq ++ p)
+      .groupBy(_._1)
+      .map { case (path, pathItems) =>
+        val pathItem = pathItems.map(_._2).reduce { (i, j) =>
+          i.copy(
+            get = i.get.orElse(j.get),
+            put = i.put.orElse(j.put),
+            post = i.post.orElse(j.post),
+            delete = i.delete.orElse(j.delete),
+            options = i.options.orElse(j.options),
+            head = i.head.orElse(j.head),
+            patch = i.patch.orElse(j.patch),
+            trace = i.trace.orElse(j.trace),
+          )
+        }
+        (path, pathItem)
+      }
+
   def toJson: String =
     JsonCodec
       .jsonEncoder(JsonCodec.Config(ignoreEmptyCollections = true))(OpenAPI.schema)

diff --git a/zio-http/src/test/resources/endpoint/openapi/multiple-methods-on-same-path.json b/zio-http/src/test/resources/endpoint/openapi/multiple-methods-on-same-path.json
@@ -0,0 +1,62 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Multiple Methods on Same Path",
+    "version": "1.0"
+  },
+  "paths": {
+    "/test": {
+      "get": {
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "null"
+              }
+            }
+          },
+          "required": false
+        },
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "post": {
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    }
+  },
+  "components": {}
+}
diff --git a/zio-http/src/test/scala/zio/http/endpoint/openapi/OpenAPIGenSpec.scala b/zio-http/src/test/scala/zio/http/endpoint/openapi/OpenAPIGenSpec.scala
@@ -1,15 +1,15 @@
 package zio.http.endpoint.openapi
 
-import zio.Scope
 import zio.json.ast.Json
 import zio.json.{EncoderOps, JsonEncoder}
 import zio.test._
+import zio.{Scope, ZIO}
 
 import zio.schema.annotation.{caseName, discriminatorName, noDiscriminator, optionalField, transientField}
 import zio.schema.codec.JsonCodec
 import zio.schema.{DeriveSchema, Schema}
 
-import zio.http.Method.GET
+import zio.http.Method.{GET, POST}
 import zio.http._
 import zio.http.codec.{Doc, HttpCodec, QueryCodec}
 import zio.http.endpoint._
@@ -2228,6 +2228,25 @@ object OpenAPIGenSpec extends ZIOSpecDefault {
             |}""".stripMargin
         assertTrue(json == toJsonAst(expectedJson))
       },
+      test("multiple methods on same path") {
+        val getEndpoint  = Endpoint(GET / "test")
+          .out[String](MediaType.text.`plain`)
+        val postEndpoint = Endpoint(POST / "test")
+          .in[String]
+          .out[String](Status.Created, MediaType.text.`plain`)
+        val generated    = OpenAPIGen.fromEndpoints(
+          "Multiple Methods on Same Path",
+          "1.0",
+          getEndpoint,
+          postEndpoint,
+        )
+        val json         = toJsonAst(generated)
+        for {
+          expectedJson <- ZIO.acquireReleaseWith(
+            ZIO.attemptBlockingIO(scala.io.Source.fromResource("endpoint/openapi/multiple-methods-on-same-path.json")),
+          )(buf => ZIO.attemptBlockingIO(buf.close()).orDie)(buf => ZIO.attemptBlockingIO(buf.mkString))
+        } yield assertTrue(json == toJsonAst(expectedJson))
+      },
     )
 
 }