Represents multiple content types. This is useful for functions that can be applied to multiple content types at a time (mostly for the sake of concision).

OpenApiDslContext

interface OpenApiDslContext

This interface is passed to most of the builder classes and provides utilities that need to be present through the "DSL tree".

OpenApiVersion

enum OpenApiVersion : Enum<OpenApiVersion>

A version of the OpenAPI standard. This only includes the x.y part of the x.y.z version scheme.

OperationBuilder

class OperationBuilder(context: OpenApiDslContext) : OperationDsl, Buildable<Operation>

Builder for OperationDsl

OperationDsl

interface OperationDsl

DSL for the operation object.

ParameterBuilder

class ParameterBuilder(context: OpenApiDslContext, name: String, kind: ParameterKind) : Buildable<Parameter> , ParameterDsl

Builder for ParameterDsl

ParameterDsl

interface ParameterDsl : MediaTypeDsl

DSL for https://spec.openapis.org/oas/v3.1.0#parameter-object

ParameterKind

enum ParameterKind : Enum<ParameterKind>

The kind of parameter (i.e. its location).

PathBuilder

class PathBuilder(context: OpenApiDslContext) : PathDsl, Buildable<PathItem>

Builder for PathDsl

PathDsl

interface PathDsl : OperationDsl

DSL for the path item object.

PathsBuilder

class PathsBuilder(context: OpenApiDslContext) : PathsDsl, Buildable<Paths>

Builder for PathsDsl.

PathsDsl

interface PathsDsl

DSL for the paths object.

PredefinedContentTypesDsl

interface PredefinedContentTypesDsl

Interface that contains standard content types.

RequestBodyBuilder

class RequestBodyBuilder(context: OpenApiDslContext) : BodyBuilder, RequestBodyDsl, Buildable<RequestBody>

Builder for the request body DSL

RequestBodyDsl

interface RequestBodyDsl : BodyDsl

DSL for the request body object.

ResponseBuilder

class ResponseBuilder(context: OpenApiDslContext) : BodyBuilder, ResponseDsl, Buildable<ApiResponse>

Builder for Response objects, implementing the ResponseDsl.

ResponseDsl

interface ResponseDsl : BodyDsl

DSL for https://spec.openapis.org/oas/v3.1.0#response-object.

RootBuilder

class RootBuilder(context: OpenApiDslContext, infoBuilder: InfoBuilder = InfoBuilder(), paths: PathsBuilder = PathsBuilder(context), securitySchemes: MutableMap<String, SecuritySchemeBuilder> = mutableMapOf()) : RootDsl, InfoDsl, PathsDsl, Buildable<OpenAPI>

Builder for the RootDsl.

RootDsl

interface RootDsl : InfoDsl, TagsDsl, PathsDsl

This is the root DSL object for the Tegral OpenAPI DSL.

SecuritySchemeBuilder

class SecuritySchemeBuilder : SecuritySchemeDsl, Buildable<SecurityScheme>

Builder for the security scheme DSL.

SecuritySchemeDsl

interface SecuritySchemeDsl

DSL for the security scheme object.

ServerBuilder

class ServerBuilder(url: String) : ServerDsl, Buildable<Server>

Builder for ServerDsl.

ServerDsl

interface ServerDsl

DSL for the server object.

SimpleDslContext

class SimpleDslContext : OpenApiDslContext

An implementation of OpenApiDslContext that keeps context information for Swagger Core.

TagBuilder

class TagBuilder(name: String) : TagDsl, Buildable<Tag>

Actual builder for TagDsl.

TagDsl

interface TagDsl

DSL for the tag object.

TagsDsl

interface TagsDsl

DSL for the objects that can contain tags listed by name.

Properties

apiKeyType

val SecuritySchemeDsl.apiKeyType: Unit

Sets the type of this security scheme to API key.

httpType

val SecuritySchemeDsl.httpType: Unit

Sets the type of this security scheme to HTTP.

inCookie

val SecuritySchemeDsl.inCookie: Unit

Sets the location of this security scheme to be in a cookie.

inHeader

val SecuritySchemeDsl.inHeader: Unit

Sets the location of this security scheme to be in a header.

inQuery

val SecuritySchemeDsl.inQuery: Unit

Sets the location of this security scheme to be in a query parameter.

mutualTlsType

val SecuritySchemeDsl.mutualTlsType: Unit

Sets the type of this security scheme to Mutual TLS.

oauth2Type

val SecuritySchemeDsl.oauth2Type: Unit

Sets the type of this security scheme to OAuth 2.

openIdConnectType

val SecuritySchemeDsl.openIdConnectType: Unit

Sets the type of this security scheme to OpenID Connect.

Functions

openApi

fun openApi(builder: RootDsl.() -> Unit): OpenAPI

Entrypoint for the Tegral OpenAPI DSL.

schema

inline fun <T> MediaTypeDsl.schema()

Set the schema to be of type T.

inline fun <T> MediaTypeDsl.schema(example: T)

Set the schema to be of type T, with the given object set as the example.

fun <T> MediaTypeDsl.schema(ktype: KType, example: T)

Set the schema to be of type ktype, with the given object set as the example.

toJson

fun OpenAPI.toJson(version: OpenApiVersion = OpenApiVersion.V3_0): String

Dumps this OpenAPI object to a JSON string.

toOpenApi31

fun OpenAPI.toOpenApi31(): OpenAPI

Converts this OpenAPI object to a version 3.1 OpenAPI object.

toYaml

fun OpenAPI.toYaml(version: OpenApiVersion = OpenApiVersion.V3_0): String

Dumps this OpenAPI object to a prettified YAML string.