-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract SttpOpenAPICirceEncoders to own file
- Loading branch information
Showing
2 changed files
with
176 additions
and
175 deletions.
There are no files selected for viewing
176 changes: 176 additions & 0 deletions
176
openapi-circe/src/main/scala/sttp/apispec/openapi/circe/SttpOpenAPICirceEncoders.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| package sttp.apispec.openapi | ||
| package circe | ||
|
|
||
| import io.circe.generic.semiauto._ | ||
| import io.circe.parser._ | ||
| import io.circe.syntax._ | ||
| import io.circe.{Encoder, Json, JsonObject} | ||
| import sttp.apispec.{ | ||
| Discriminator, | ||
| ExampleMultipleValue, | ||
| ExampleSingleValue, | ||
| ExampleValue, | ||
| ExtensionValue, | ||
| ExternalDocumentation, | ||
| OAuthFlow, | ||
| OAuthFlows, | ||
| Reference, | ||
| ReferenceOr, | ||
| Schema, | ||
| SchemaType, | ||
| SecurityScheme, | ||
| Tag | ||
| } | ||
|
|
||
| import scala.collection.immutable.ListMap | ||
|
|
||
|
|
||
| trait SttpOpenAPICirceEncoders { | ||
| // note: these are strict val-s, order matters! | ||
|
|
||
| implicit def encoderReferenceOr[T: Encoder]: Encoder[ReferenceOr[T]] = { | ||
| case Left(Reference(ref, summary, description)) => | ||
| Json | ||
| .obj( | ||
| "$ref" := ref, | ||
| "summary" := summary, | ||
| "description" := description | ||
| ) | ||
| .dropNullValues | ||
| case Right(t) => implicitly[Encoder[T]].apply(t) | ||
| } | ||
|
|
||
| implicit val extensionValue: Encoder[ExtensionValue] = | ||
| Encoder.instance(e => parse(e.value).getOrElse(Json.fromString(e.value))) | ||
| implicit val encoderOAuthFlow: Encoder[OAuthFlow] = deriveEncoder[OAuthFlow].mapJsonObject(expandExtensions) | ||
| implicit val encoderOAuthFlows: Encoder[OAuthFlows] = deriveEncoder[OAuthFlows].mapJsonObject(expandExtensions) | ||
| implicit val encoderSecurityScheme: Encoder[SecurityScheme] = | ||
| deriveEncoder[SecurityScheme].mapJsonObject(expandExtensions) | ||
| implicit val encoderExampleSingleValue: Encoder[ExampleSingleValue] = { | ||
| case ExampleSingleValue(value: String) => parse(value).getOrElse(Json.fromString(value)) | ||
| case ExampleSingleValue(value: Int) => Json.fromInt(value) | ||
| case ExampleSingleValue(value: Long) => Json.fromLong(value) | ||
| case ExampleSingleValue(value: Float) => Json.fromFloatOrString(value) | ||
| case ExampleSingleValue(value: Double) => Json.fromDoubleOrString(value) | ||
| case ExampleSingleValue(value: Boolean) => Json.fromBoolean(value) | ||
| case ExampleSingleValue(value: BigDecimal) => Json.fromBigDecimal(value) | ||
| case ExampleSingleValue(value: BigInt) => Json.fromBigInt(value) | ||
| case ExampleSingleValue(null) => Json.Null | ||
| case ExampleSingleValue(value) => Json.fromString(value.toString) | ||
| } | ||
| implicit val encoderExampleValue: Encoder[ExampleValue] = { | ||
| case e: ExampleSingleValue => encoderExampleSingleValue(e) | ||
| case ExampleMultipleValue(values) => | ||
| Json.arr(values.map(v => encoderExampleSingleValue(ExampleSingleValue(v))): _*) | ||
| } | ||
| implicit val encoderSchemaType: Encoder[SchemaType] = { e => Encoder.encodeString(e.value) } | ||
| implicit val encoderSchema: Encoder[Schema] = deriveEncoder[Schema].mapJsonObject(expandExtensions) | ||
| implicit val encoderReference: Encoder[Reference] = deriveEncoder[Reference] | ||
| implicit val encoderHeader: Encoder[Header] = deriveEncoder[Header] | ||
| implicit val encoderExample: Encoder[Example] = deriveEncoder[Example].mapJsonObject(expandExtensions) | ||
| implicit val encoderResponse: Encoder[Response] = deriveEncoder[Response].mapJsonObject(expandExtensions) | ||
| implicit val encoderLink: Encoder[Link] = deriveEncoder[Link].mapJsonObject(expandExtensions) | ||
| implicit val encoderCallback: Encoder[Callback] = Encoder.instance { callback => | ||
| Json.obj(callback.pathItems.map { case (path, pathItem) => path -> pathItem.asJson }.toList: _*) | ||
| } | ||
| implicit val encoderEncoding: Encoder[Encoding] = deriveEncoder[Encoding].mapJsonObject(expandExtensions) | ||
| implicit val encoderMediaType: Encoder[MediaType] = deriveEncoder[MediaType].mapJsonObject(expandExtensions) | ||
| implicit val encoderRequestBody: Encoder[RequestBody] = deriveEncoder[RequestBody].mapJsonObject(expandExtensions) | ||
| implicit val encoderParameterStyle: Encoder[ParameterStyle] = { e => Encoder.encodeString(e.value) } | ||
| implicit val encoderParameterIn: Encoder[ParameterIn] = { e => Encoder.encodeString(e.value) } | ||
| implicit val encoderParameter: Encoder[Parameter] = deriveEncoder[Parameter].mapJsonObject(expandExtensions) | ||
| implicit val encoderResponseMap: Encoder[ListMap[ResponsesKey, ReferenceOr[Response]]] = | ||
| (responses: ListMap[ResponsesKey, ReferenceOr[Response]]) => { | ||
| val fields = responses.map { | ||
| case (ResponsesDefaultKey, r) => ("default", r.asJson) | ||
| case (ResponsesCodeKey(code), r) => (code.toString, r.asJson) | ||
| case (ResponsesRangeKey(range), r) => (s"${range}XX", r.asJson) | ||
| } | ||
|
|
||
| Json.obj(fields.toSeq: _*) | ||
| } | ||
| implicit val encoderResponses: Encoder[Responses] = Encoder.instance { resp => | ||
| val extensions = resp.extensions.asJsonObject | ||
| val respJson = resp.responses.asJson | ||
| respJson.asObject.map(_.deepMerge(extensions).asJson).getOrElse(respJson) | ||
| } | ||
| implicit val encoderOperation: Encoder[Operation] = { | ||
| // this is needed to override the encoding of `security: List[SecurityRequirement]`. An empty security requirement | ||
| // should be represented as an empty object (`{}`), not `null`, which is the default encoding of `ListMap`s. | ||
| implicit def encodeListMap[V: Encoder]: Encoder[ListMap[String, V]] = doEncodeListMap(nullWhenEmpty = false) | ||
|
|
||
| implicit def encodeListMapForCallbacks: Encoder[ListMap[String, ReferenceOr[Callback]]] = | ||
| doEncodeListMap(nullWhenEmpty = true) | ||
|
|
||
| deriveEncoder[Operation].mapJsonObject(expandExtensions) | ||
| } | ||
| implicit val encoderPathItem: Encoder[PathItem] = deriveEncoder[PathItem].mapJsonObject(expandExtensions) | ||
| implicit val encoderPaths: Encoder[Paths] = Encoder.instance { paths => | ||
| val extensions = paths.extensions.asJsonObject | ||
| val pathItems = paths.pathItems.asJson | ||
| pathItems.asObject.map(_.deepMerge(extensions).asJson).getOrElse(pathItems) | ||
| } | ||
| implicit val encoderComponents: Encoder[Components] = deriveEncoder[Components].mapJsonObject(expandExtensions) | ||
| implicit val encoderServerVariable: Encoder[ServerVariable] = | ||
| deriveEncoder[ServerVariable].mapJsonObject(expandExtensions) | ||
| implicit val encoderServer: Encoder[Server] = deriveEncoder[Server].mapJsonObject(expandExtensions) | ||
| implicit val encoderExternalDocumentation: Encoder[ExternalDocumentation] = | ||
| deriveEncoder[ExternalDocumentation].mapJsonObject(expandExtensions) | ||
| implicit val encoderTag: Encoder[Tag] = deriveEncoder[Tag].mapJsonObject(expandExtensions) | ||
| implicit val encoderInfo: Encoder[Info] = deriveEncoder[Info].mapJsonObject(expandExtensions) | ||
| implicit val encoderContact: Encoder[Contact] = deriveEncoder[Contact].mapJsonObject(expandExtensions) | ||
| implicit val encoderLicense: Encoder[License] = deriveEncoder[License].mapJsonObject(expandExtensions) | ||
| implicit val encoderOpenAPI: Encoder[OpenAPI] = | ||
| deriveEncoder[OpenAPI].mapJsonObject(expandExtensions).mapJson(_.deepDropNullValues) | ||
| implicit val encoderDiscriminator: Encoder[Discriminator] = deriveEncoder[Discriminator] | ||
|
|
||
| implicit def encodeList[T: Encoder]: Encoder[List[T]] = { | ||
| case Nil => Json.Null | ||
| case l: List[T] => Json.arr(l.map(i => implicitly[Encoder[T]].apply(i)): _*) | ||
| } | ||
|
|
||
| implicit def encodeListMap[V: Encoder]: Encoder[ListMap[String, V]] = doEncodeListMap(nullWhenEmpty = true) | ||
|
|
||
| private def doEncodeListMap[V: Encoder](nullWhenEmpty: Boolean): Encoder[ListMap[String, V]] = { | ||
| case m: ListMap[String, V] if m.isEmpty && nullWhenEmpty => Json.Null | ||
| case m: ListMap[String, V] => | ||
| val properties = m.mapValues(v => implicitly[Encoder[V]].apply(v)).toList | ||
| Json.obj(properties: _*) | ||
| } | ||
|
|
||
| /* | ||
| Openapi extensions are arbitrary key-value data that could be added to some of models in specifications, such | ||
| as `OpenAPI` itself, `License`, `Parameter`, etc. | ||
| The key could be any string (that starts with 'x-' by convention) and value is arbitrary Json (string, object, | ||
| array, etc.) | ||
| To be able to encode such arbitrary data and apply it to the final Json it passed through the `extensions` field | ||
| in models and moved (or expanded) to the object level while encoding | ||
| Example: | ||
| ``` | ||
| case class License( | ||
| name: String, | ||
| url: Option[String], | ||
| extensions: ListMap[String, ExtensionValue] = ListMap.empty | ||
| ) | ||
| val licenseWithExtension = License("hello", None, ListMap("x-foo", ExtensionValue("42")) | ||
| ``` | ||
| Applying the transformation below we end up with the following schema in the specification: | ||
| ``` | ||
| license: | ||
| name: hello | ||
| x-foo: 42 | ||
| ``` | ||
| */ | ||
| private def expandExtensions(jsonObject: JsonObject): JsonObject = { | ||
| val extensions = jsonObject("extensions") | ||
| val jsonWithoutExt = jsonObject.filterKeys(_ != "extensions") | ||
| extensions.flatMap(_.asObject).map(extObject => extObject.deepMerge(jsonWithoutExt)).getOrElse(jsonWithoutExt) | ||
| } | ||
| } |
175 changes: 0 additions & 175 deletions
175
openapi-circe/src/main/scala/sttp/apispec/openapi/circe/package.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,178 +1,3 @@ | ||
| package sttp.apispec.openapi | ||
|
|
||
| import io.circe.generic.semiauto._ | ||
| import io.circe.parser._ | ||
| import io.circe.syntax._ | ||
| import io.circe.{Encoder, Json, JsonObject} | ||
| import sttp.apispec.{ | ||
| Discriminator, | ||
| ExampleMultipleValue, | ||
| ExampleSingleValue, | ||
| ExampleValue, | ||
| ExtensionValue, | ||
| ExternalDocumentation, | ||
| OAuthFlow, | ||
| OAuthFlows, | ||
| Reference, | ||
| ReferenceOr, | ||
| Schema, | ||
| SchemaType, | ||
| SecurityScheme, | ||
| Tag | ||
| } | ||
|
|
||
| import scala.collection.immutable.ListMap | ||
|
|
||
| package object circe extends SttpOpenAPICirceEncoders | ||
|
|
||
| package circe { | ||
| trait SttpOpenAPICirceEncoders { | ||
| // note: these are strict val-s, order matters! | ||
|
|
||
| implicit def encoderReferenceOr[T: Encoder]: Encoder[ReferenceOr[T]] = { | ||
| case Left(Reference(ref, summary, description)) => | ||
| Json | ||
| .obj( | ||
| "$ref" := ref, | ||
| "summary" := summary, | ||
| "description" := description | ||
| ) | ||
| .dropNullValues | ||
| case Right(t) => implicitly[Encoder[T]].apply(t) | ||
| } | ||
|
|
||
| implicit val extensionValue: Encoder[ExtensionValue] = | ||
| Encoder.instance(e => parse(e.value).getOrElse(Json.fromString(e.value))) | ||
| implicit val encoderOAuthFlow: Encoder[OAuthFlow] = deriveEncoder[OAuthFlow].mapJsonObject(expandExtensions) | ||
| implicit val encoderOAuthFlows: Encoder[OAuthFlows] = deriveEncoder[OAuthFlows].mapJsonObject(expandExtensions) | ||
| implicit val encoderSecurityScheme: Encoder[SecurityScheme] = | ||
| deriveEncoder[SecurityScheme].mapJsonObject(expandExtensions) | ||
| implicit val encoderExampleSingleValue: Encoder[ExampleSingleValue] = { | ||
| case ExampleSingleValue(value: String) => parse(value).getOrElse(Json.fromString(value)) | ||
| case ExampleSingleValue(value: Int) => Json.fromInt(value) | ||
| case ExampleSingleValue(value: Long) => Json.fromLong(value) | ||
| case ExampleSingleValue(value: Float) => Json.fromFloatOrString(value) | ||
| case ExampleSingleValue(value: Double) => Json.fromDoubleOrString(value) | ||
| case ExampleSingleValue(value: Boolean) => Json.fromBoolean(value) | ||
| case ExampleSingleValue(value: BigDecimal) => Json.fromBigDecimal(value) | ||
| case ExampleSingleValue(value: BigInt) => Json.fromBigInt(value) | ||
| case ExampleSingleValue(null) => Json.Null | ||
| case ExampleSingleValue(value) => Json.fromString(value.toString) | ||
| } | ||
| implicit val encoderExampleValue: Encoder[ExampleValue] = { | ||
| case e: ExampleSingleValue => encoderExampleSingleValue(e) | ||
| case ExampleMultipleValue(values) => | ||
| Json.arr(values.map(v => encoderExampleSingleValue(ExampleSingleValue(v))): _*) | ||
| } | ||
| implicit val encoderSchemaType: Encoder[SchemaType] = { e => Encoder.encodeString(e.value) } | ||
| implicit val encoderSchema: Encoder[Schema] = deriveEncoder[Schema].mapJsonObject(expandExtensions) | ||
| implicit val encoderReference: Encoder[Reference] = deriveEncoder[Reference] | ||
| implicit val encoderHeader: Encoder[Header] = deriveEncoder[Header] | ||
| implicit val encoderExample: Encoder[Example] = deriveEncoder[Example].mapJsonObject(expandExtensions) | ||
| implicit val encoderResponse: Encoder[Response] = deriveEncoder[Response].mapJsonObject(expandExtensions) | ||
| implicit val encoderLink: Encoder[Link] = deriveEncoder[Link].mapJsonObject(expandExtensions) | ||
| implicit val encoderCallback: Encoder[Callback] = Encoder.instance { callback => | ||
| Json.obj(callback.pathItems.map { case (path, pathItem) => path -> pathItem.asJson }.toList: _*) | ||
| } | ||
| implicit val encoderEncoding: Encoder[Encoding] = deriveEncoder[Encoding].mapJsonObject(expandExtensions) | ||
| implicit val encoderMediaType: Encoder[MediaType] = deriveEncoder[MediaType].mapJsonObject(expandExtensions) | ||
| implicit val encoderRequestBody: Encoder[RequestBody] = deriveEncoder[RequestBody].mapJsonObject(expandExtensions) | ||
| implicit val encoderParameterStyle: Encoder[ParameterStyle] = { e => Encoder.encodeString(e.value) } | ||
| implicit val encoderParameterIn: Encoder[ParameterIn] = { e => Encoder.encodeString(e.value) } | ||
| implicit val encoderParameter: Encoder[Parameter] = deriveEncoder[Parameter].mapJsonObject(expandExtensions) | ||
| implicit val encoderResponseMap: Encoder[ListMap[ResponsesKey, ReferenceOr[Response]]] = | ||
| (responses: ListMap[ResponsesKey, ReferenceOr[Response]]) => { | ||
| val fields = responses.map { | ||
| case (ResponsesDefaultKey, r) => ("default", r.asJson) | ||
| case (ResponsesCodeKey(code), r) => (code.toString, r.asJson) | ||
| case (ResponsesRangeKey(range), r) => (s"${range}XX", r.asJson) | ||
| } | ||
|
|
||
| Json.obj(fields.toSeq: _*) | ||
| } | ||
| implicit val encoderResponses: Encoder[Responses] = Encoder.instance { resp => | ||
| val extensions = resp.extensions.asJsonObject | ||
| val respJson = resp.responses.asJson | ||
| respJson.asObject.map(_.deepMerge(extensions).asJson).getOrElse(respJson) | ||
| } | ||
| implicit val encoderOperation: Encoder[Operation] = { | ||
| // this is needed to override the encoding of `security: List[SecurityRequirement]`. An empty security requirement | ||
| // should be represented as an empty object (`{}`), not `null`, which is the default encoding of `ListMap`s. | ||
| implicit def encodeListMap[V: Encoder]: Encoder[ListMap[String, V]] = doEncodeListMap(nullWhenEmpty = false) | ||
|
|
||
| implicit def encodeListMapForCallbacks: Encoder[ListMap[String, ReferenceOr[Callback]]] = | ||
| doEncodeListMap(nullWhenEmpty = true) | ||
|
|
||
| deriveEncoder[Operation].mapJsonObject(expandExtensions) | ||
| } | ||
| implicit val encoderPathItem: Encoder[PathItem] = deriveEncoder[PathItem].mapJsonObject(expandExtensions) | ||
| implicit val encoderPaths: Encoder[Paths] = Encoder.instance { paths => | ||
| val extensions = paths.extensions.asJsonObject | ||
| val pathItems = paths.pathItems.asJson | ||
| pathItems.asObject.map(_.deepMerge(extensions).asJson).getOrElse(pathItems) | ||
| } | ||
| implicit val encoderComponents: Encoder[Components] = deriveEncoder[Components].mapJsonObject(expandExtensions) | ||
| implicit val encoderServerVariable: Encoder[ServerVariable] = | ||
| deriveEncoder[ServerVariable].mapJsonObject(expandExtensions) | ||
| implicit val encoderServer: Encoder[Server] = deriveEncoder[Server].mapJsonObject(expandExtensions) | ||
| implicit val encoderExternalDocumentation: Encoder[ExternalDocumentation] = | ||
| deriveEncoder[ExternalDocumentation].mapJsonObject(expandExtensions) | ||
| implicit val encoderTag: Encoder[Tag] = deriveEncoder[Tag].mapJsonObject(expandExtensions) | ||
| implicit val encoderInfo: Encoder[Info] = deriveEncoder[Info].mapJsonObject(expandExtensions) | ||
| implicit val encoderContact: Encoder[Contact] = deriveEncoder[Contact].mapJsonObject(expandExtensions) | ||
| implicit val encoderLicense: Encoder[License] = deriveEncoder[License].mapJsonObject(expandExtensions) | ||
| implicit val encoderOpenAPI: Encoder[OpenAPI] = | ||
| deriveEncoder[OpenAPI].mapJsonObject(expandExtensions).mapJson(_.deepDropNullValues) | ||
| implicit val encoderDiscriminator: Encoder[Discriminator] = deriveEncoder[Discriminator] | ||
|
|
||
| implicit def encodeList[T: Encoder]: Encoder[List[T]] = { | ||
| case Nil => Json.Null | ||
| case l: List[T] => Json.arr(l.map(i => implicitly[Encoder[T]].apply(i)): _*) | ||
| } | ||
|
|
||
| implicit def encodeListMap[V: Encoder]: Encoder[ListMap[String, V]] = doEncodeListMap(nullWhenEmpty = true) | ||
|
|
||
| private def doEncodeListMap[V: Encoder](nullWhenEmpty: Boolean): Encoder[ListMap[String, V]] = { | ||
| case m: ListMap[String, V] if m.isEmpty && nullWhenEmpty => Json.Null | ||
| case m: ListMap[String, V] => | ||
| val properties = m.mapValues(v => implicitly[Encoder[V]].apply(v)).toList | ||
| Json.obj(properties: _*) | ||
| } | ||
|
|
||
| /* | ||
| Openapi extensions are arbitrary key-value data that could be added to some of models in specifications, such | ||
| as `OpenAPI` itself, `License`, `Parameter`, etc. | ||
| The key could be any string (that starts with 'x-' by convention) and value is arbitrary Json (string, object, | ||
| array, etc.) | ||
| To be able to encode such arbitrary data and apply it to the final Json it passed through the `extensions` field | ||
| in models and moved (or expanded) to the object level while encoding | ||
| Example: | ||
| ``` | ||
| case class License( | ||
| name: String, | ||
| url: Option[String], | ||
| extensions: ListMap[String, ExtensionValue] = ListMap.empty | ||
| ) | ||
| val licenseWithExtension = License("hello", None, ListMap("x-foo", ExtensionValue("42")) | ||
| ``` | ||
| Applying the transformation below we end up with the following schema in the specification: | ||
| ``` | ||
| license: | ||
| name: hello | ||
| x-foo: 42 | ||
| ``` | ||
| */ | ||
| private def expandExtensions(jsonObject: JsonObject): JsonObject = { | ||
| val extensions = jsonObject("extensions") | ||
| val jsonWithoutExt = jsonObject.filterKeys(_ != "extensions") | ||
| extensions.flatMap(_.asObject).map(extObject => extObject.deepMerge(jsonWithoutExt)).getOrElse(jsonWithoutExt) | ||
| } | ||
| } | ||
| } |