http4k-contract/org.http4k.contract.openapi.v2/OpenApi2

OpenApi2

open class OpenApi2<out NODE>(apiInfo: ApiInfo, json: Json<NODE>, baseUri: Uri? = null, extensions: List<OpenApiExtension> = emptyList(), securityRenderer: SecurityRenderer = OpenApi2SecurityRenderer, schemaGenerator: JsonSchemaCreator<NODE, NODE> = JsonToJsonSchema(json), errorResponseRenderer: ErrorResponseRenderer = JsonErrorResponseRenderer(json)) : 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.

Constructors

Link copied to clipboard
constructor(apiInfo: ApiInfo, json: Json<NODE>, baseUri: Uri? = null, extensions: List<OpenApiExtension> = emptyList(), securityRenderer: SecurityRenderer = OpenApi2SecurityRenderer, schemaGenerator: JsonSchemaCreator<NODE, NODE> = JsonToJsonSchema(json), errorResponseRenderer: ErrorResponseRenderer = JsonErrorResponseRenderer(json))

Functions

Link copied to clipboard
open override fun badRequest(lensFailure: LensFailure): Response
Link copied to clipboard
open override fun description(contractRoot: PathSegments, security: Security?, routes: List<ContractRoute>, tags: Set<Tag>, webhooks: Map<String, List<WebCallback>>): Response
Link copied to clipboard
open override fun notFound(): Response