http4k-api-openapi/org.http4k.contract.openapi.v3

Package-level declarations

Types

Api

data class Api<NODE>

ApiPath

sealed class ApiPath<NODE>

ApiServer

data class ApiServer(val url: Uri, val description: String? = null)

BodyContent

sealed class BodyContent

Components

data class Components<NODE>(val schemas: NODE, val securitySchemes: NODE)

HasSchema

fun interface HasSchema<NODE>

OpenApi3

class OpenApi3<NODE : Any>(apiInfo: ApiInfo, json: Json<NODE>, extensions: List<OpenApiExtension> = emptyList(), apiRenderer: ApiRenderer<Api<NODE>, NODE> = OpenApi3ApiRenderer(json), securityRenderer: SecurityRenderer = OpenApi3SecurityRenderer, errorResponseRenderer: ErrorResponseRenderer = JsonErrorResponseRenderer(json), servers: List<ApiServer> = emptyList(), version: OpenApiVersion = _3_0_0) : 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.

OpenApi3ApiRenderer

class OpenApi3ApiRenderer<NODE : Any>(json: Json<NODE>, refLocationPrefix: String = "components/schemas", jsonToJsonSchema: JsonSchemaCreator<NODE, NODE> = JsonToJsonSchema(json, refLocationPrefix)) : ApiRenderer<Api<NODE>, NODE>

Converts a API to OpenApi3 format JSON, using non-reflective JSON marshalling - this is the limited version

RequestContents

class RequestContents<NODE>(val content: Map<String, BodyContent>? = null) : HasSchema<NODE>

RequestParameter

sealed class RequestParameter<NODE>

ResponseContents

class ResponseContents<NODE>(val description: String?, val content: Map<String, BodyContent> = emptyMap()) : HasSchema<NODE>

Properties

OpenApi3SecurityRenderer

val OpenApi3SecurityRenderer: SecurityRenderer

Compose the supported Security models

Functions

AutoJsonToJsonSchema

fun AutoJsonToJsonSchema(json: ConfigurableJackson, typeToMetadata: Map<KType, FieldMetadata> = emptyMap(), modelNamer: SchemaModelNamer = Simple): AutoJsonToJsonSchema<JsonNode>

OpenApi3

fun OpenApi3(apiInfo: ApiInfo, json: ConfigurableJackson = OpenAPIJackson, extensions: List<OpenApiExtension> = emptyList(), servers: List<ApiServer> = emptyList(), version: OpenApiVersion = OpenApiVersion._3_0_0, typeToMetadata: Map<KType, FieldMetadata> = emptyMap(), modelNamer: SchemaModelNamer = Simple): OpenApi3<JsonNode>

Defaults for configuring OpenApi3 with Jackson