api

Package org.http4k.contract.openapi.v3

Types

Name	Summary
Api	`data class Api<NODE>`
ApiPath	`sealed class ApiPath<NODE>`
AutoJsonToJsonSchema	`class AutoJsonToJsonSchema<NODE :` `Any> :` `JsonSchemaCreator<Any, NODE>`
BodyContent	`sealed class BodyContent`
Components	`data class Components<NODE>`
Field	`data class Field`
FieldMetadata	`data class FieldMetadata`
FieldMetadataRetrievalStrategy	`interface FieldMetadataRetrievalStrategy : (Any,` `String) ->` `FieldMetadata`
FieldRetrieval	`interface FieldRetrieval : (Any,` `String) ->` `Field`
HasSchema	`interface HasSchema<NODE>`
JacksonFieldMetadataRetrievalStrategy	`object JacksonFieldMetadataRetrievalStrategy :` `FieldMetadataRetrievalStrategy`
JacksonJsonNamingAnnotated	`class JacksonJsonNamingAnnotated :` `FieldRetrieval`
JacksonJsonPropertyAnnotated	`object JacksonJsonPropertyAnnotated :` `FieldRetrieval`
JsonToJsonSchema	`class JsonToJsonSchema<NODE> :` `JsonSchemaCreator<NODE, NODE>`
NoOpFieldMetadataRetrievalStrategy	`class NoOpFieldMetadataRetrievalStrategy :` `FieldMetadataRetrievalStrategy`
OpenApi3	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.`class OpenApi3<NODE :` `Any> :` `ContractRenderer,` `ErrorResponseRenderer`
OpenApi3ApiRenderer	Converts a API to OpenApi3 format JSON.`class OpenApi3ApiRenderer<NODE :` `Any> :` `ApiRenderer<Api<NODE>, NODE>`
RequestContents	`class RequestContents<NODE> :` `HasSchema<NODE>`
RequestParameter	`sealed class RequestParameter<NODE>`
ResponseContents	`class ResponseContents<NODE> :` `HasSchema<NODE>`
SchemaModelNamer	`interface SchemaModelNamer : (Any) ->` `String`
SimpleLookup	`class SimpleLookup :` `FieldRetrieval`

Exceptions

Name	Summary
NoFieldFound	`class NoFieldFound :` `RuntimeException`

Properties

Name	Summary
OpenApi3SecurityRenderer	Compose the supported Security models`val OpenApi3SecurityRenderer:` `SecurityRenderer`
value	`val` `ParamMeta.value:` `String`

Functions

Name	Summary
<no name provided>	`fun <no name provided>():` `Unit`
AutoJsonToJsonSchema	`fun AutoJsonToJsonSchema(json:` `Jackson):` `AutoJsonToJsonSchema<JsonNode>`
OpenApi3	Defaults for configuring OpenApi3 with Jackson`fun OpenApi3(apiInfo:` `ApiInfo, json:` `Jackson` `= Jackson, extensions:` `List<OpenApiExtension> = emptyList()):` `OpenApi3<JsonNode>`

Companion Object Properties

Name	Summary
renderer	`val ApiKeySecurity.Companion.renderer:` `SecurityRenderer` `val AuthCodeOAuthSecurity.Companion.renderer:` `SecurityRenderer` `val BasicAuthSecurity.Companion.renderer:` `SecurityRenderer` `val BearerAuthSecurity.Companion.renderer:` `SecurityRenderer` `val ImplicitOAuthSecurity.Companion.renderer:` `SecurityRenderer`