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

Package-level declarations

Types

Link copied to clipboard
class SwaggerConfig

A configuration for the Swagger UI endpoint.

Functions

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

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

fun Route.swaggerUI(path: String, swaggerFile: String = "openapi/documentation.yaml", block: SwaggerConfig.() -> Unit = {})

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

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

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