api

http4k / org.http4k.contract / ContractRenderer

ContractRenderer

interface ContractRenderer : ErrorResponseRenderer (source)

Functions

Name Summary
description abstract fun description(contractRoot: PathSegments, security: Security?, routes: List<ContractRoute>): Response

Inherited Functions

Name Summary
badRequest open fun badRequest(lensFailure: LensFailure): Response
notFound open fun notFound(): Response

Extension Functions

Name Summary
with fun <T> T.with(vararg modifiers: (T) -> T): T

Inheritors

Name Summary
NoRenderer object NoRenderer : ContractRenderer
OpenApi2 open class OpenApi2<out NODE> : ContractRenderer, ErrorResponseRenderer
Contract renderer for OpenApi2 format JSON. Note that for the JSON schema generation, auto-naming of object models is used as the input relies on JSON objects and not JVM classees.
OpenApi3 class OpenApi3<NODE : Any> : ContractRenderer, ErrorResponseRenderer
Contract renderer for OpenApi3 format JSON. For the JSON schema generation, naming of object models will default to either reflective or hashcode based depending on if a Auto Json is passed.
SimpleJson class SimpleJson<out NODE> : ContractRenderer, ErrorResponseRenderer