ktor-server-swagger/io.ktor.server.plugins.swagger

Package-level declarations

Types

A configuration for the Swagger UI endpoint.

Adds a Swagger UI endpoint to the current route.

fun Route.swaggerUI(path: String, apiFile: File, block: SwaggerConfig.() -> Unit = {}): Route

Creates a get endpoint with swaggerUI at path rendered from the apiFile.

fun Route.swaggerUI(path: String, swaggerFile: String, block: SwaggerConfig.() -> Unit = {}): Route

Creates a get endpoint with SwaggerUI at path rendered from the OpenAPI file located at swaggerFile.

Configures a route to serve Swagger UI and its corresponding API specification.