org.http4k.contract.openapi.v3.JsonToJsonSchema.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http4k-contract Show documentation
http4k typesafe HTTP contracts and OpenApi support
There is a newer version: 5.31.0.0
package org.http4k.contract.openapi.v3

import org.http4k.format.Json
import org.http4k.format.JsonType
import org.http4k.lens.ParamMeta
import org.http4k.util.IllegalSchemaException
import org.http4k.util.JsonSchema
import org.http4k.util.JsonSchemaCreator

class JsonToJsonSchema(
    private val json: Json,
    private val refLocationPrefix: String = "components/schemas"
) : JsonSchemaCreator {
    override fun toSchema(obj: NODE, overrideDefinitionId: String?, refModelNamePrefix: String?) =
        JsonSchema(obj, emptySet()).toSchema(overrideDefinitionId, refModelNamePrefix ?: "")

    private fun JsonSchema.toSchema(
        overrideDefinitionId: String? = null,
        refModelNamePrefix: String
    ): JsonSchema =
        when (json.typeOf(node)) {
            JsonType.Object -> objectSchema(overrideDefinitionId, refModelNamePrefix)
            JsonType.Array -> arraySchema(overrideDefinitionId, refModelNamePrefix)
            JsonType.String -> JsonSchema(ParamMeta.StringParam.schema(json.string(json.text(node))), definitions)
            JsonType.Integer -> numberSchema()
            JsonType.Number -> numberSchema()
            JsonType.Boolean -> JsonSchema(ParamMeta.BooleanParam.schema(json.boolean(json.bool(node))), definitions)
            JsonType.Null -> throw IllegalSchemaException("Cannot use a null value in a schema!")
            else -> throw IllegalSchemaException("unknown type")
        }

    private fun JsonSchema.numberSchema(): JsonSchema {
        val text = json.text(node)
        val schema = when {
            text.contains(".") -> ParamMeta.NumberParam.schema(json.number(text.toBigDecimal()))
            else -> ParamMeta.IntegerParam.schema(json.number(text.toBigInteger()))
        }
        return JsonSchema(schema, definitions)
    }

    private fun JsonSchema.arraySchema(
        overrideDefinitionId: String?,
        refModelNamePrefix: String
    ): JsonSchema {
        val (node, definitions) = json.elements(node).toList().firstOrNull()?.let {
            JsonSchema(it, definitions).toSchema(overrideDefinitionId, refModelNamePrefix)
        } ?: throw IllegalSchemaException("Cannot use an empty list to generate a schema!")
        return JsonSchema(json { obj("type" to string("array"), "items" to node) }, definitions)
    }

    private fun JsonSchema.objectSchema(
        overrideDefinitionId: String?,
        refModelNamePrefix: String
    ): JsonSchema {
        val (fields, subDefinitions) = json.fields(node)
            .filter { json.typeOf(it.second) != JsonType.Null } // filter out null fields for which type can't be inferred
            .fold(listOf>() to definitions) { (memoFields, memoDefinitions), (first, second) ->
                JsonSchema(second, memoDefinitions).toSchema(refModelNamePrefix = refModelNamePrefix)
                    .let { memoFields + (first to it.node) to it.definitions }
            }

        val newDefinition = json {
            obj(
                "type" to string("object"),
                "required" to array(emptyList()),
                "properties" to obj(fields)
            )
        }
        val definitionId = refModelNamePrefix + (overrideDefinitionId ?: ("object" + newDefinition.hashCode()))
        val allDefinitions = subDefinitions + (definitionId to newDefinition)
        return JsonSchema(json { obj("\$ref" to string("#/$refLocationPrefix/$definitionId")) }, allDefinitions)
    }

    private fun ParamMeta.schema(example: NODE): NODE = json { obj("type" to string(value), "example" to example) }
}