http4k-contract/org.http4k.contract.openapi/ApiRenderer

ApiRenderer

interface ApiRenderer<API, NODE> : JsonSchemaCreator<Any, NODE>

Renders the contract contents in OpenApi JSON format.

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract fun api(api: API): NODE
Link copied to clipboard
fun <API : Any, NODE : Any> ApiRenderer<API, NODE>.cached(): ApiRenderer<API, NODE>

Cache the result of the API render, in case it is expensive to calculate.

Link copied to clipboard
abstract fun toSchema(obj: Any, overrideDefinitionId: String?, refModelNamePrefix: String?): JsonSchema<NODE>