tegral-openapi-dsl/guru.zoroark.tegral.openapi.dsl/BodyBuilder

BodyBuilder

abstract class BodyBuilder(context: OpenApiDslContext) : BodyDsl

A default builder for anything that needs to implement BodyDsl.

Should not be used as is and should be subclassed by builders that also wish to include a body DSL.

Inheritors

RequestBodyBuilder

ResponseBuilder

Constructors

constructor(context: OpenApiDslContext)

Properties

open override val content: MutableList<Pair<String, Buildable<MediaType>>>

A "map" containing descriptions of potential payloads. The key is a media type or media type range and teh value describes it.

open val form: ContentType

ContentType object for application/x-www-form-urlencoded

open val json: ContentType

ContentType object for application/json

open val plainText: ContentType

ContentType object for text/plain

open val xml: ContentType

ContentType object for application/xml

Functions

open infix override fun String.content(builder: MediaTypeBuilder.() -> Unit)

Creates a content entry for this content type (the string receiver) and body (the builder configured by the lambda). See MediaTypeDsl for more information on what you can do in the lambda.

open operator fun ContentType.invoke(builder: MediaTypeBuilder.() -> Unit)

Creates a content entry for this content type and body. See MediaTypeDsl for more information on what you can do in the lambda.

open operator fun MultiContentType.invoke(builder: MediaTypeBuilder.() -> Unit)

Creates content entries for each of the provided content types with the same body. See MediaTypeDsl for more information on what you can do in the lambda.