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

Package-level declarations

Types

typealias ~~JsonToJsonSchema<T>~~ = org.http4k.contract.jsonschema.v2.JsonToJsonSchema<T>

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.

Properties

OpenApi2SecurityRenderer

val OpenApi2SecurityRenderer: SecurityRenderer

Compose the supported Security models

renderer

val ApiKeySecurity.Companion.renderer: SecurityRenderer

val BasicAuthSecurity.Companion.renderer: SecurityRenderer

val ImplicitOAuthSecurity.Companion.renderer: SecurityRenderer

Functions

OpenApi2

fun OpenApi2(apiInfo: ApiInfo, baseUri: Uri, json: ConfigurableJackson = OpenAPIJackson, extensions: List<OpenApiExtension> = emptyList()): OpenApi2<JsonNode>

Defaults for configuring OpenApi2 with Jackson