Package-level declarations

Types

Link copied to clipboard
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

Link copied to clipboard

Compose the supported Security models

Link copied to clipboard
val ApiKeySecurity.Companion.renderer: SecurityRenderer
val BasicAuthSecurity.Companion.renderer: SecurityRenderer
val ImplicitOAuthSecurity.Companion.renderer: SecurityRenderer

Functions

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

Defaults for configuring OpenApi2 with Jackson