describe

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

Specify additional information about the API via the RootDsl.

You can use this function to further customize the OpenAPI document (such as the document's title, version, description, etc.). Adding information in an application describe block is similar to adding information in the configuration block of TegralOpenApiKtor.

You must install the TegralOpenApiKtor plugin before running this function.


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

Adds an OpenAPI operation description to this route.

The TegralOpenApiKtor plugin needs to be installed for this to work.