main.io.github.smiley4.ktorswaggerui.data.SwaggerUIData.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ktor-swagger-ui Show documentation

Ktor plugin to document routes and provide a Swagger-UI

There is a newer version: 3.4.0

package io.github.smiley4.ktorswaggerui.data

/**
 * Common configuration for the swagger-ui.
 */
data class SwaggerUIData(
    val validatorUrl: String?,
    val displayOperationId: Boolean,
    val showTagFilterInput: Boolean,
    val sort: SwaggerUiSort,
    val syntaxHighlight: SwaggerUiSyntaxHighlight,
    val withCredentials: Boolean,
) {

    companion object {
        val DEFAULT = SwaggerUIData(
            validatorUrl = null,
            displayOperationId = false,
            showTagFilterInput = false,
            sort = SwaggerUiSort.NONE,
            syntaxHighlight = SwaggerUiSyntaxHighlight.AGATE,
            withCredentials = false,
        )
    }

}