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

SwaggerConfig

class SwaggerConfig : OpenApiDocDsl(source)

A configuration for the Swagger UI endpoint.

Report a problem

Constructors

constructor()

Properties

open override var components: Components?

var deepLinking: Boolean

Whether to allow deep linking in Swagger UI.

open override val extensions: MutableMap<String, GenericElement>

open override var externalDocs: ExternalDocs?

faviconLocation

var faviconLocation: String

Swagger favicon location

open override var info: OpenApiInfo

open override var openapiVersion: String

packageLocation

var packageLocation: String

Swagger package location

var remotePath: String

Relative path from the swagger URL root to the specification file.

var source: OpenApiDocSource

Defines the source of the OpenAPI specification.

var version: String

Specifies a Swagger UI version to use.

Functions

fun customStyle(path: String?)

Specifies a URL for a custom CSS applied to a Swagger UI.

open override fun security(configure: Security.Builder.() -> Unit)

open override fun servers(configure: Servers.Builder.() -> Unit)

open override fun tag(tag: String)