io.javalin.openapi.plugin.redoc.ReDocPlugin.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javalin-redoc-plugin Show documentation

Serve ReDoc UI for OpenAPI specification

There is a newer version: 6.4.0

package io.javalin.openapi.plugin.redoc

import io.javalin.Javalin
import io.javalin.plugin.Plugin
import io.javalin.plugin.PluginLifecycleInit
import io.javalin.security.RouteRole

class ReDocConfiguration {
    /** Page title */
    var title = "OpenApi documentation"
    /** ReDoc route */
    var uiPath = "/redoc"
    /* Roles permitted to access ReDoc UI */
    var roles: Array = emptyArray()
    /** Location of OpenApi documentation */
    var documentationPath = "/openapi"
    /* Custom base path */
    var basePath: String? = null
    /** ReDoc Bundle version **/
    var version = "2.0.0-rc.70"
    /** ReDoc WebJar route */
    var webJarPath = "/webjars/redoc"
}

open class ReDocPlugin @JvmOverloads constructor(private val configuration: ReDocConfiguration = ReDocConfiguration()) : Plugin, PluginLifecycleInit {

    override fun init(app: Javalin) {}

    override fun apply(app: Javalin) {
        val reDocHandler = ReDocHandler(
            title = configuration.title,
            documentationPath = configuration.documentationPath,
            version = configuration.version,
            routingPath = app.cfg.routing.contextPath,
            basePath = configuration.basePath
        )

        val webJarHandler = ReDocWebJarHandler(
            redocWebJarPath = configuration.webJarPath
        )

        app
            .get(configuration.uiPath, reDocHandler, *configuration.roles)
            .get("${configuration.webJarPath}/*", webJarHandler, *configuration.roles)
    }

}