http4k-contract/org.http4k.contract.openapi

Package-level declarations

Types

data class ApiInfo(val title: String, val version: String, val description: String? = null)

interface ApiRenderer<API, NODE> : JsonSchemaCreator<Any, NODE>

Renders the contract contents in OpenApi JSON format.

OpenApiExtension

interface OpenApiExtension

Provides a way to apply extensions to the OpenAPI JSON document.

object OpenAPIJackson : ConfigurableJackson

enum OpenApiVersion : Enum<OpenApiVersion>

typealias Render<NODE> = Json<NODE>.() -> NODE

interface RenderModes

SecurityRenderer

interface SecurityRenderer

Provides rendering of Security models in to OpenApi specs.

Functions

fun <API : Any, NODE : Any> ApiRenderer<API, NODE>.cached(): ApiRenderer<API, NODE>

Cache the result of the API render, in case it is expensive to calculate.

fun operationId(routeMeta: RouteMeta, method: Method, description: String): String

inline fun <T : Security> rendererFor(crossinline fn: (T) -> RenderModes): SecurityRenderer