correct circe encoder for OpenAPI

softwaremill · Feb 10, 2021 · 7f536d3 · 7f536d3
1 parent 856570a
commit 7f536d3
Show file tree

Hide file tree

Showing 6 changed files with 162 additions and 80 deletions.
diff --git a/apispec/openapi-circe/src/main/scala/sttp/tapir/openapi/circe/package.scala b/apispec/openapi-circe/src/main/scala/sttp/tapir/openapi/circe/package.scala
@@ -75,7 +75,7 @@ trait TapirOpenAPICirceEncoders {
   implicit val encoderInfo: Encoder[Info] = deriveEncoder[Info]
   implicit val encoderContact: Encoder[Contact] = deriveEncoder[Contact]
   implicit val encoderLicense: Encoder[License] = deriveEncoder[License]
-  implicit val encoderOpenAPI: Encoder[OpenAPI] = deriveEncoder[OpenAPI]
+  implicit val encoderOpenAPI: Encoder[OpenAPI] = deriveEncoder[OpenAPI].mapJson(_.deepDropNullValues)
   implicit val encoderDiscriminator: Encoder[Discriminator] = deriveEncoder[Discriminator]
   implicit def encodeList[T: Encoder]: Encoder[List[T]] = {
     case Nil        => Json.Null

diff --git a/doc/docs/openapi.md b/doc/docs/openapi.md
@@ -1,3 +1,4 @@
+
 # Generating OpenAPI documentation
 
 To use, add the following dependencies:
@@ -53,9 +54,12 @@ OpenAPIDocsInterpreter.toOpenAPI(List(addBook, booksListing, booksListingByGenre
 The openapi case classes can then be serialised, either to JSON or YAML using [Circe](https://circe.github.io/circe/):
 
 ```scala mdoc:silent
+import io.circe.syntax.EncoderOps
+import sttp.tapir.openapi.circe._
 import sttp.tapir.openapi.circe.yaml._
 
 println(docs.toYaml)
+println(docs.asJson)
 ```
 
 ## Options

diff --git a/docs/openapi-docs/src/test/resources/expected.json b/docs/openapi-docs/src/test/resources/expected.json
@@ -0,0 +1,54 @@
+{
+  "openapi" : "3.0.3",
+  "info" : {
+    "title" : "Fruits",
+    "version" : "1.0"
+  },
+  "paths" : {
+    "/" : {
+      "get" : {
+        "operationId" : "getRoot",
+        "parameters" : [
+          {
+            "name" : "fruit",
+            "in" : "query",
+            "required" : true,
+            "schema" : {
+              "type" : "string"
+            }
+          },
+          {
+            "name" : "amount",
+            "in" : "query",
+            "required" : false,
+            "schema" : {
+              "type" : "integer"
+            }
+          }
+        ],
+        "responses" : {
+          "200" : {
+            "description" : "",
+            "content" : {
+              "text/plain" : {
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/delete" : {
+      "delete" : {
+        "operationId" : "deleteApiDelete",
+        "responses" : {
+          "200" : {
+            "description" : "ok"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/docs/openapi-docs/src/test/scala/sttp/tapir/docs/openapi/VerifyJsonTest.scala b/docs/openapi-docs/src/test/scala/sttp/tapir/docs/openapi/VerifyJsonTest.scala
@@ -0,0 +1,20 @@
+package sttp.tapir.docs.openapi
+
+import io.circe.syntax.EncoderOps
+import org.scalatest.funsuite.AnyFunSuite
+import org.scalatest.matchers.should.Matchers
+import sttp.tapir.openapi._
+import sttp.tapir.openapi.circe._
+import sttp.tapir.tests._
+
+class VerifyJsonTest extends AnyFunSuite with Matchers {
+
+  test("should match the expected json") {
+    val expectedJson = load("expected.json")
+
+    val actualJson = OpenAPIDocsInterpreter.toOpenAPI(List(in_query_query_out_string, delete_endpoint), Info("Fruits", "1.0")).asJson
+    val actualJsonNoIndent = noIndentation(actualJson.toString())
+
+    actualJsonNoIndent shouldBe expectedJson
+  }
+}