api

http4k / org.http4k.contract / ContractRenderer

ContractRenderer

interface ContractRenderer : ErrorResponseRenderer

Functions

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

Inheritors

Name Summary
NoRenderer object NoRenderer : ContractRenderer
OpenApi2 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.open class OpenApi2<out NODE> : ContractRenderer, ErrorResponseRenderer
OpenApi3 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.class OpenApi3<NODE : Any> : ContractRenderer, ErrorResponseRenderer
SimpleJson class SimpleJson<out NODE> : ContractRenderer, ErrorResponseRenderer