-
Notifications
You must be signed in to change notification settings - Fork 422
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
codegen: Support default values in schema objects (#3614)
- Loading branch information
1 parent
171fb66
commit 3880806
Showing
10 changed files
with
475 additions
and
73 deletions.
There are no files selected for viewing
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
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
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
112 changes: 112 additions & 0 deletions
112
openapi-codegen/core/src/main/scala/sttp/tapir/codegen/openapi/models/Renderer.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,112 @@ | ||
| package sttp.tapir.codegen.openapi.models | ||
|
|
||
| import io.circe.Json | ||
| import sttp.tapir.codegen.openapi.models.OpenapiSchemaType.{ | ||
| OpenapiSchemaArray, | ||
| OpenapiSchemaBinary, | ||
| OpenapiSchemaBoolean, | ||
| OpenapiSchemaDateTime, | ||
| OpenapiSchemaDouble, | ||
| OpenapiSchemaEnum, | ||
| OpenapiSchemaFloat, | ||
| OpenapiSchemaInt, | ||
| OpenapiSchemaLong, | ||
| OpenapiSchemaMap, | ||
| OpenapiSchemaObject, | ||
| OpenapiSchemaRef, | ||
| OpenapiSchemaString, | ||
| OpenapiSchemaUUID | ||
| } | ||
|
|
||
| object Renderer { | ||
| private def lookup(allModels: Map[String, OpenapiSchemaType], ref: OpenapiSchemaRef): OpenapiSchemaType = allModels( | ||
| ref.name.stripPrefix("#/components/schemas/") | ||
| ) | ||
|
|
||
| private def renderStringWithName( | ||
| value: String | ||
| )(allModels: Map[String, OpenapiSchemaType], thisType: OpenapiSchemaType, name: String): String = | ||
| thisType match { | ||
| case ref: OpenapiSchemaRef => | ||
| renderStringWithName(value)(allModels, lookup(allModels, ref), ref.name.stripPrefix("#/components/schemas/")) | ||
| case OpenapiSchemaString(_) => '"' +: value :+ '"' | ||
| case OpenapiSchemaEnum(_, _, _) => s"$name.$value" | ||
| case OpenapiSchemaDateTime(_) => s"""java.time.Instant.parse("$value")""" | ||
| case OpenapiSchemaBinary(_) => s""""$value".getBytes("utf-8")""" | ||
| case OpenapiSchemaUUID(_) => s"""java.util.UUID.fromString("$value")""" | ||
| case other => throw new IllegalArgumentException(s"Cannot render a string as type ${other.getClass.getName}") | ||
| } | ||
| private def renderMapWithName( | ||
| kvs: Map[String, Json] | ||
| )(allModels: Map[String, OpenapiSchemaType], thisType: OpenapiSchemaType, name: String): String = { | ||
| def errorForKey(k: String): Nothing = throw new IllegalArgumentException( | ||
| s"Cannot find property $k in schema $name when constructing default value" | ||
| ) | ||
| thisType match { | ||
| case ref: OpenapiSchemaRef => renderMapWithName(kvs)(allModels, lookup(allModels, ref), ref.name.stripPrefix("#/components/schemas/")) | ||
| case OpenapiSchemaMap(types, _) => | ||
| s"Map(${kvs.map { case (k, v) => s""""$k" -> ${render(allModels, types, isOptional = false)(v)}""" }.mkString(", ")})" | ||
| case OpenapiSchemaObject(properties, required, _) => | ||
| val kvsWithProps = kvs.map { case (k, v) => (k, (v, properties.get(k).getOrElse(errorForKey(k)))) } | ||
| s"$name(${kvsWithProps | ||
| .map { case (k, (v, p)) => s"""$k = ${render(allModels, p.`type`, p.`type`.nullable || !required.contains(k))(v)}""" } | ||
| .mkString(", ")})" | ||
| case other => throw new IllegalArgumentException(s"Cannot render a map as type ${other.getClass.getName}") | ||
| } | ||
| } | ||
|
|
||
| def render(allModels: Map[String, OpenapiSchemaType], thisType: OpenapiSchemaType, isOptional: Boolean)(json: Json): String = | ||
| if (json == Json.Null) { | ||
| if (isOptional) "None" else "null" | ||
| } else { | ||
| def fail(tpe: String, schemaType: OpenapiSchemaType, reason: Option[String] = None): Nothing = | ||
| throw new IllegalArgumentException( | ||
| s"Cannot render a $tpe as type ${schemaType.getClass.getName}.${reason.map(" " + _).getOrElse("")}" | ||
| ) | ||
| val base: String = json.fold[String]( | ||
| "null", | ||
| jsBool => | ||
| thisType match { | ||
| case ref: OpenapiSchemaRef => render(allModels, lookup(allModels, ref), isOptional = false)(json) | ||
| case OpenapiSchemaBoolean(_) => jsBool.toString | ||
| case other => fail("boolean", other) | ||
| }, | ||
| jsonNumber => | ||
| thisType match { | ||
| case ref: OpenapiSchemaRef => render(allModels, lookup(allModels, ref), isOptional = false)(json) | ||
| case l @ OpenapiSchemaLong(_) => s"${jsonNumber.toLong.getOrElse(fail("number", l, Some(s"$jsonNumber is not a long")))}L" | ||
| case i @ OpenapiSchemaInt(_) => jsonNumber.toInt.getOrElse(fail("number", i, Some(s"$jsonNumber is not an int"))).toString | ||
| case OpenapiSchemaFloat(_) => s"${jsonNumber.toFloat}f" | ||
| case OpenapiSchemaDouble(_) => s"${jsonNumber.toDouble}d" | ||
| case other => fail("number", other) | ||
| }, | ||
| jsonString => | ||
| thisType match { | ||
| case ref: OpenapiSchemaRef => | ||
| renderStringWithName(jsonString)(allModels, lookup(allModels, ref), ref.name.stripPrefix("#/components/schemas/")) | ||
| case OpenapiSchemaString(_) => '"' +: jsonString :+ '"' | ||
| case OpenapiSchemaDateTime(_) => s"""java.time.Instant.parse("$jsonString")""" | ||
| case OpenapiSchemaBinary(_) => s""""$jsonString".getBytes("utf-8")""" | ||
| case OpenapiSchemaUUID(_) => s"""java.util.UUID.fromString("$jsonString")""" | ||
| // case OpenapiSchemaEnum(_, _, _) => // inline enum definitions are not currently supported, so let it throw | ||
| case other => fail("string", other) | ||
| }, | ||
| jsonArray => | ||
| thisType match { | ||
| case ref: OpenapiSchemaRef => render(allModels, lookup(allModels, ref), isOptional = false)(json) | ||
| case OpenapiSchemaArray(items, _) => s"Vector(${jsonArray.map(render(allModels, items, isOptional = false)).mkString(", ")})" | ||
| case other => fail("list", other) | ||
| }, | ||
| jsonObject => | ||
| thisType match { | ||
| case ref: OpenapiSchemaRef => | ||
| renderMapWithName(jsonObject.toMap)(allModels, lookup(allModels, ref), ref.name.stripPrefix("#/components/schemas/")) | ||
| case OpenapiSchemaMap(types, _) => | ||
| s"Map(${jsonObject.toMap.map { case (k, v) => s""""$k" -> ${render(allModels, types, isOptional = false)(v)}""" }.mkString(", ")})" | ||
| case other => fail("map", other) | ||
| } | ||
| ) | ||
| if (isOptional) s"Some($base)" else base | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.