http4k-contract/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)

AutoJsonToJsonSchema

typealias ~~AutoJsonToJsonSchema<T>~~ = org.http4k.contract.jsonschema.v3.AutoJsonToJsonSchema<T>

BodyContent

sealed class BodyContent

Components

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

Field

typealias ~~Field~~ = org.http4k.contract.jsonschema.v3.Field

FieldMetadata

typealias ~~FieldMetadata~~ = org.http4k.contract.jsonschema.v3.FieldMetadata

FieldMetadataRetrievalStrategy

typealias ~~FieldMetadataRetrievalStrategy~~ = org.http4k.contract.jsonschema.v3.FieldMetadataRetrievalStrategy

FieldRetrieval

typealias ~~FieldRetrieval~~ = org.http4k.contract.jsonschema.v3.FieldRetrieval

HasSchema

fun interface HasSchema<NODE>

JacksonFieldMetadataRetrievalStrategy

typealias ~~JacksonFieldMetadataRetrievalStrategy~~ = org.http4k.contract.jsonschema.v3.JacksonFieldMetadataRetrievalStrategy

JacksonJsonNamingAnnotated

typealias ~~JacksonJsonNamingAnnotated~~ = org.http4k.contract.jsonschema.v3.JacksonJsonNamingAnnotated

JacksonJsonPropertyAnnotated

typealias ~~JacksonJsonPropertyAnnotated~~ = org.http4k.contract.jsonschema.v3.JacksonJsonPropertyAnnotated

JsonToJsonSchema

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

NoFieldFound

typealias ~~NoFieldFound~~ = org.http4k.contract.jsonschema.v3.NoFieldFound

NoOpFieldMetadataRetrievalStrategy

typealias ~~NoOpFieldMetadataRetrievalStrategy~~ = org.http4k.contract.jsonschema.v3.NoOpFieldMetadataRetrievalStrategy

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

PrimitivesFieldMetadataRetrievalStrategy

typealias ~~PrimitivesFieldMetadataRetrievalStrategy~~ = org.http4k.contract.jsonschema.v3.PrimitivesFieldMetadataRetrievalStrategy

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>

SimpleLookup

typealias ~~SimpleLookup~~ = org.http4k.contract.jsonschema.v3.SimpleLookup

Values4kFieldMetadataRetrievalStrategy

typealias ~~Values4kFieldMetadataRetrievalStrategy~~ = org.http4k.contract.jsonschema.v3.Values4kFieldMetadataRetrievalStrategy

Properties

OpenApi3SecurityRenderer

val OpenApi3SecurityRenderer: SecurityRenderer

Compose the supported Security models

Functions

AutoJsonToJsonSchema

fun AutoJsonToJsonSchema(json: ConfigurableJackson, typeToMetadata: Map<KType, FieldMetadata> = emptyMap()): 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()): OpenApi3<JsonNode>

Defaults for configuring OpenApi3 with Jackson