tegral-openapi-ktor/guru.zoroark.tegral.openapi.ktor

Package-level declarations

Types

typealias EndpointDescriptionHook = OperationDsl.() -> Unit

typealias OperationBuilderWithHooks = (OpenApiDslContext, List<EndpointDescriptionHook>) -> OperationBuilder

A lambda for creating OperationBuilders. This is useful if you need to heavily customize the operation creation process.

This lambda receives:

A context, from which types can be created (via OpenApiDslContext.computeAndRegisterSchema
A list of hooks that must be added to the description before anything else.

PathDescriptionHook

typealias PathDescriptionHook = PathDsl.() -> Unit

TegralOpenApiKtor

class TegralOpenApiKtor

A Ktor plugin that adds a Tegral OpenAPI DSL integration to the Ktor application, including:

Properties

openApi

val Application.openApi: TegralOpenApiKtor

Retrieve the TegralOpenApiKtor plugin from this application.

Functions

describe

fun Application.describe(description: RootDsl.() -> Unit)

Specify additional information about the API via the RootDsl.

infix fun Route.describe(description: OperationDsl.() -> Unit): Route

Adds an OpenAPI operation description to this route.

describeSubroutes

fun Route.describeSubroutes(hook: OperationDsl.() -> Unit)

Adds a hook to the given route. All following descriptions on endpoints that are sub-endpoints of this route will have the given hook applied to their description.

describeWith

infix fun Route.describeWith(builder: OperationBuilderWithHooks): Route

Adds an OpenAPI operation description to this route using a prepared builder.

getOpenApiOrNullWithMessage

fun Application.getOpenApiOrNullWithMessage(): TegralOpenApiKtor?

Retrieve the TegralOpenApiKtor plugin instance from this application, or print a warning message once and return null.

openApiEndpoint

fun Route.openApiEndpoint(path: String): Route

Adds a get(path) endpoint that will return the OpenAPI document for this API.