Complete Configuration

This example showcases a nearly complete - and mostly nonsensical - plugin configuration

package io.github.smiley4.ktoropenapi.examples

import io.github.smiley4.ktoropenapi.OpenApi
import io.github.smiley4.ktoropenapi.config.AuthScheme
import io.github.smiley4.ktoropenapi.config.AuthType
import io.github.smiley4.ktoropenapi.config.OpenApiPluginConfig
import io.github.smiley4.ktoropenapi.get
import io.github.smiley4.ktoropenapi.openApi
import io.github.smiley4.ktorredoc.redoc
import io.github.smiley4.ktorswaggerui.config.OperationsSort
import io.github.smiley4.ktorswaggerui.config.SwaggerUISyntaxHighlight
import io.github.smiley4.ktorswaggerui.config.TagSort
import io.github.smiley4.ktorswaggerui.swaggerUI
import io.github.smiley4.schemakenerator.reflection.ReflectionSteps.analyzeTypeUsingReflection
import io.github.smiley4.schemakenerator.swagger.SwaggerSteps.compileReferencingRoot
import io.github.smiley4.schemakenerator.swagger.SwaggerSteps.generateSwaggerSchema
import io.github.smiley4.schemakenerator.swagger.SwaggerSteps.withTitle
import io.github.smiley4.schemakenerator.swagger.data.TitleType
import io.ktor.http.ContentType
import io.ktor.http.HttpStatusCode
import io.ktor.server.application.Application
import io.ktor.server.application.install
import io.ktor.server.engine.embeddedServer
import io.ktor.server.netty.Netty
import io.ktor.server.response.respondText
import io.ktor.server.routing.route
import io.ktor.server.routing.routing

fun main() {
    embeddedServer(Netty, port = 8080, host = "localhost", module = Application::myModule).start(wait = true)
}

class Greeting(
    val name: String
)


/**
 * A (nearly) complete - and mostly nonsensical - plugin configuration
 */
private fun Application.myModule() {

    install(OpenApi) {
        info {
            title = "Example API"
            version = "latest"
            description = "An example api."
            termsOfService = "example.com"
            contact {
                name = "Mr. Example"
                url = "example.com"
                email = "example@example.com"
            }
            license {
                name = "Example License"
                url = "example.com"
                identifier = "Apache-2.0"
            }
        }
        externalDocs {
            url = "example.com"
            description = "Project documentation"
        }
        server {
            url = "localhost"
            description = "local dev-server"
            variable("version") {
                default = "1.0"
                enum = setOf("1.0", "2.0", "3.0")
                description = "the version of the server api"
            }
        }
        server {
            url = "example.com"
            description = "productive server"
            variable("version") {
                default = "1.0"
                enum = setOf("1.0", "2.0")
                description = "the version of the server api"
            }
        }
        security {
            defaultUnauthorizedResponse {
                description = "Username or password is invalid"
            }
            defaultSecuritySchemeNames("MySecurityScheme")
            securityScheme("MySecurityScheme") {
                type = AuthType.HTTP
                scheme = AuthScheme.BASIC
            }
        }
        tags {
            tagGenerator = { url -> listOf(url.firstOrNull()) }
            tag("users") {
                description = "routes to manage users"
                externalDocUrl = "example.com"
                externalDocDescription = "Users documentation"
            }
            tag("documents") {
                description = "routes to manage documents"
                externalDocUrl = "example.com"
                externalDocDescription = "Document documentation"
            }
        }
        schemas {
            schema<String>("string")
            generator = { type ->
                type
                    .analyzeTypeUsingReflection()
                    .generateSwaggerSchema()
                    .withTitle(TitleType.SIMPLE)
                    .compileReferencingRoot()
            }
        }
        examples {
            example("Id 1") {
                description = "First example id"
                value = "12345"
            }
            example("Id 2") {
                description = "Second example id"
                value = "54321"

            }
        }
        specAssigner = { _, _ -> OpenApiPluginConfig.DEFAULT_SPEC_ID }
        pathFilter = { _, url -> url.firstOrNull() != "hidden" }
        ignoredRouteSelectors = emptySet()
        ignoredRouteSelectorClassNames = emptySet()
        postBuild = { api, name -> println("Completed api '$name': $api") }
    }


    routing {

        route("api.json") {
            openApi()
        }
        route("swagger") {
            swaggerUI("/api.json") {
                deepLinking = true
                displayOperationId = false
                defaultModelsExpandDepth = 1
                defaultModelExpandDepth = 1
                displayRequestDuration = false
                filter = false
                maxDisplayedTags = 99
                operationsSorter = OperationsSort.HTTP_METHOD
                showExtensions = false
                showCommonExtensions = false
                tagsSorter = TagSort.ALPHANUMERICALLY
                syntaxHighlight = SwaggerUISyntaxHighlight.MONOKAI
                tryItOutEnabled = true
                requestSnippetsEnabled = true
                oauth2RedirectUrl = "example.com"
                requestInterceptor = "req => { alert(JSON.stringify(req)); return req; }"
                responseInterceptor = "res => { alert(JSON.stringify(res)); return res; }"
                supportedSubmitMethods = setOf("get", "put", "post", "delete", "options", "head", "patch", "trace")
                onlineSpecValidator()
                withCredentials = false
                persistAuthorization = false
            }
        }
        route("redoc") {
            redoc("/api.json") {
                pageTitle = "Redoc - My Api"
                disableSearch = false
                minCharacterLengthToInitSearch = 1
                expandResponses = listOf("all")
                expandSingleSchemaField = true
                hideDownloadButton = false
                hideHostname = false
                hideLoading = false
                hideRequestPayloadSample = true
                hideOneOfDescription = false
                hideSchemaPattern = false
                hideSchemaTitles = true
                hideSecuritySection = false
                hideSingleRequestSampleTab = true
                jsonSampleExpandLevel = "1"
                maxDisplayedEnumValues = 3
                menuToggle = true
                nativeScrollbars = true
                onlyRequiredInSamples = false
                pathInMiddlePanel = true
                requiredPropsFirst = true
                schemaExpansionLevel = "all"
                showObjectSchemaExamples = true
                showWebhookVerb = true
                simpleOneOfTypeLabel = true
                sortEnumValuesAlphabetically = true
                sortOperationsAlphabetically = true
                sortPropsAlphabetically = true
                sortTagsAlphabetically = true
                theme = """
                  {
                    "sidebar": {
                      "backgroundColor": "lightblue"
                    },
                    "rightPanel": {
                      "backgroundColor": "darkblue"
                    }
                  }
                """.trimIndent()
            }
        }

        // a documented route
        get("hello", {
            operationId = "hello"
            summary = "hello world route"
            description = "A Hello-World route as an example."
            tags("hello", "example")
            specName = OpenApiPluginConfig.DEFAULT_SPEC_ID
            deprecated = false
            hidden = false
            protected = false
            securitySchemeNames(emptyList())
            externalDocs {
                url = "example.com/hello"
                description = "external documentation of 'hello'-route"
            }
            request {
                queryParameter<String>("name") {
                    description = "the name to greet"
                    example("Josh") {
                        value = "Josh"
                        summary = "Example name"
                        description = "An example name for this query parameter"
                    }
                }
                body<Unit>()
            }
            response {
                code(HttpStatusCode.OK) {
                    description = "successful request - always returns 'Hello World!'"
                    header<String>("x-random") {
                        description = "A header with some random number"
                        required = true
                        deprecated = false
                        explode = false
                    }
                    body<Greeting> {
                        description = "the greeting object with the name of the person to greet."
                        mediaTypes(ContentType.Application.Json)
                        required = true
                    }
                }
            }
            server {
                url = "example.com"
                description = "productive server for 'hello'-route"
                variable("version") {
                    default = "1.0"
                    enum = setOf("1.0", "2.0")
                    description = "the version of the server api"
                }
            }
        }) {
            call.respondText("Hello ${call.request.queryParameters["name"]}")
        }

    }

}