TegralOpenApiKtor

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

Support for providing basic OpenAPI information right from the install(...) { ... } call.
Support for describing endpoints and registering operations.
Producing an OpenAPI document as an object
Support for serving OpenAPI documents from an endpoint

Constructors

constructor()

Configuration block for the plugin, allows you to directly add information to the OpenAPI document.

object Plugin : BaseApplicationPlugin<ApplicationCallPipeline, TegralOpenApiKtor.Configuration, TegralOpenApiKtor>

Ktor plugin object for TegralOpenApiKtor.

The context used by this plugin. This can be used to register new types.

Create an OpenAPI document from the information registered in this plugin.

Retrieve all registered hooks for the parents of the given route.

fun registerOperation(path: String, method: HttpMethod, operationBuilder: OperationBuilder)

fun registerOperation(path: String, method: HttpMethod, operation: OperationDsl.() -> Unit)

Runs the given lambda against the root OpenAPI builder, allowing to further customize the content of the OpenAPI document.