org.http4k.contract.openapi.v3.OpenApi3SecurityRenderer.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http4k-contract Show documentation
http4k typesafe HTTP contracts and OpenApi support
There is a newer version: 5.31.0.0
package org.http4k.contract.openapi.v3

import org.http4k.contract.openapi.Render
import org.http4k.contract.openapi.RenderModes
import org.http4k.contract.openapi.SecurityRenderer
import org.http4k.contract.openapi.rendererFor
import org.http4k.contract.security.ApiKeySecurity
import org.http4k.contract.security.AuthCodeOAuthSecurity
import org.http4k.contract.security.BasicAuthSecurity
import org.http4k.contract.security.BearerAuthSecurity
import org.http4k.contract.security.ImplicitOAuthSecurity
import org.http4k.contract.security.OpenIdConnectSecurity
import org.http4k.contract.security.UserCredentialsOAuthSecurity

/**
 * Compose the supported Security models
 */
val OpenApi3SecurityRenderer: SecurityRenderer = SecurityRenderer(
    ApiKeySecurity.renderer,
    AuthCodeOAuthSecurity.renderer,
    BasicAuthSecurity.renderer,
    BearerAuthSecurity.renderer,
    ImplicitOAuthSecurity.renderer,
    UserCredentialsOAuthSecurity.renderer,
    OpenIdConnectSecurity.renderer
)

val ApiKeySecurity.Companion.renderer
    get() = rendererFor> {
        object : RenderModes {
            override fun  full(): Render = {
                obj(it.name to obj(
                    "type" to string("apiKey"),
                    "in" to string(it.param.meta.location),
                    "name" to string(it.param.meta.name)
                ))
            }

            override fun  ref(): Render = { obj(it.name to array(emptyList())) }
        }
    }

val AuthCodeOAuthSecurity.Companion.renderer
    get() = rendererFor {
        object : RenderModes {
            override fun  full(): Render = {
                obj(it.name to obj(
                    "type" to string("oauth2"),
                    "flows" to obj("authorizationCode" to
                        obj(
                            listOfNotNull(
                                "authorizationUrl" to string(it.authorizationUrl.toString()),
                                it.refreshUrl?.let { "refreshUrl" to string(it.toString()) },
                                "tokenUrl" to string(it.tokenUrl.toString()),
                                "scopes" to obj(it.scopes.map { it.name to string(it.description) }
                                )
                            ) + it.extraFields.map { it.key to string(it.value) }
                        )
                    )
                ))
            }

            override fun  ref(): Render = { obj(it.name to array(it.scopes.map { string(it.name) })) }
        }
    }

val BasicAuthSecurity.Companion.renderer
    get() = rendererFor {
        object : RenderModes {
            override fun  full(): Render = {
                obj(it.name to obj(
                    "scheme" to string("basic"),
                    "type" to string("http")
                ))
            }

            override fun  ref(): Render = { obj(it.name to array(emptyList())) }
        }
    }

val BearerAuthSecurity.Companion.renderer
    get() = rendererFor {
        object : RenderModes {
            override fun  full(): Render = {
                obj(it.name to obj(
                    "scheme" to string("bearer"),
                    "type" to string("http")
                ))
            }

            override fun  ref(): Render = { obj(it.name to array(emptyList())) }
        }
    }

val ImplicitOAuthSecurity.Companion.renderer
    get() = rendererFor {
        object : RenderModes {
            override fun  full(): Render = {
                obj(it.name to obj(
                    "type" to string("oauth2"),
                    "flows" to obj("implicit" to
                        obj(
                            listOfNotNull(
                                "authorizationUrl" to string(it.authorizationUrl.toString()),
                                it.refreshUrl?.let { "refreshUrl" to string(it.toString()) },
                                "scopes" to obj(it.scopes.map { it.name to string(it.description) }
                                )
                            ) + it.extraFields.map { it.key to string(it.value) }
                        )
                    )
                ))
            }

            override fun  ref(): Render = { obj(it.name to array(it.scopes.map { string(it.name) })) }
        }
    }

val UserCredentialsOAuthSecurity.Companion.renderer
    get() = rendererFor {
        object : RenderModes {
            override fun  full(): Render = {
                obj(it.name to obj(
                    "type" to string("oauth2"),
                    "flows" to obj("password" to
                        obj(
                            listOfNotNull(
                                it.refreshUrl?.let { "refreshUrl" to string(it.toString()) },
                                "tokenUrl" to string(it.tokenUrl.toString()),
                                "scopes" to obj(it.scopes.map { it.name to string(it.description) }
                                )
                            ) + it.extraFields.map { it.key to string(it.value) }
                        )
                    )
                ))
            }

            override fun  ref(): Render = { obj(it.name to array(it.scopes.map { string(it.name) })) }
        }
    }

val OpenIdConnectSecurity.Companion.renderer
    get() = rendererFor {
        object : RenderModes {
            override fun  full(): Render = {
                obj(it.name to
                    obj(
                        listOfNotNull(
                            "type" to string("openIdConnect"),
                            "openIdConnectUrl" to string(it.discoveryUrl.toString()),
                        )
                    )
                )
            }

            override fun  ref(): Render = { obj(it.name to array(emptyList())) }
        }
    }