ktor-server-routing-openapi/io.ktor.server.routing.openapi

Package-level declarations

Types

CollectSchemaReferences

class CollectSchemaReferences(schemaToComponent: (JsonSchema) -> String?) : OperationMapping

Replace all JSON class schema values with component references.

OpenApiDocSource

sealed interface OpenApiDocSource

Sealed type for the different sources used for generating an OpenAPI document.

OperationMapping

fun interface OperationMapping

Mapping function for Operation.

RouteOperationFunction

typealias RouteOperationFunction = Operation.Builder.() -> Unit

Function that configures an OpenAPI Operation.

Properties

AuthSecuritySchemesAttributeKey

val AuthSecuritySchemesAttributeKey: AttributeKey<Map<String, SecurityScheme>>

Attribute key for storing OpenAPI security scheme metadata for authentication providers. Maps provider names to their corresponding SecurityScheme definitions.

JsonSchemaAttributeKey

val JsonSchemaAttributeKey: AttributeKey<JsonSchemaInference>

Attribute key for io.ktor.server.application.Application JSON schema inference override.

OperationDescribeAttributeKey

val OperationDescribeAttributeKey: AttributeKey<List<RouteOperationFunction>>

Attribute key for including OpenAPI metadata on a Route.

OperationHiddenAttributeKey

val OperationHiddenAttributeKey: AttributeKey<Unit>

Attribute key for hiding the given Route from OpenAPI documentation.

PopulateMediaTypeDefaults

val PopulateMediaTypeDefaults: OperationMapping

Populate Parameter.content and response Header.content fields with default values.

Functions

describe

@ExperimentalKtorApi

fun Route.describe(configure: RouteOperationFunction): Route

Annotate a Route with an OpenAPI Operation.

findSecuritySchemes

fun Application.findSecuritySchemes(useCache: Boolean = true): Map<String, ReferenceOr<SecurityScheme>>

Retrieves all registered security schemes from the application.

findSecuritySchemesOrRefs

fun Application.findSecuritySchemesOrRefs(useCache: Boolean = true): Map<String, ReferenceOr<SecurityScheme>>

Retrieves all registered security schemes from the application.

hide

@ExperimentalKtorApi

fun Route.hide(): Route

Hide a Route from OpenAPI documentation.

mapToPathItems

fun Sequence<Route>.mapToPathItems(onOperation: OperationMapping = PopulateMediaTypeDefaults): Map<String, PathItem>

Converts the sequence of Routes to a map of String to PathItems.

mapToPathItemsAndSchema

fun Sequence<Route>.mapToPathItemsAndSchema(): Pair<Map<String, PathItem>, Map<String, JsonSchema>>

Finds all PathItems under the given Route, and extracts object schema as references.

plus

operator fun OpenApiDoc.plus(route: Route): OpenApiDoc

Combines the current OpenApiDoc instance with a single Route.

operator fun OpenApiDoc.plus(routes: Collection<Route>): OpenApiDoc

Overload for OpenApiDoc.plus that accepts a Collection of Routes.

operator fun OpenApiDoc.plus(securitySchemes: Map<String, ReferenceOr<SecurityScheme>>): OpenApiDoc

Combines the current OpenApiDoc instance with additional security schemes.

operator fun OpenApiDoc.plus(routes: Sequence<Route>): OpenApiDoc

Combines the current OpenApiDoc instance with a sequence of routes, resulting in a new OpenApiDoc containing the updated paths and components based on the provided routes.

registerApiKeySecurityScheme

fun Application.registerApiKeySecurityScheme(name: String? = null, keyName: String, keyLocation: SecuritySchemeIn, description: String = ApiKeySecurityScheme.DEFAULT_DESCRIPTION)

Registers an API Key authentication security scheme.

registerBasicAuthSecurityScheme

fun Application.registerBasicAuthSecurityScheme(name: String? = null, description: String = HttpSecurityScheme.DEFAULT_BASIC_DESCRIPTION)

Registers a Basic HTTP authentication security scheme.

registerBearerAuthSecurityScheme

fun Application.registerBearerAuthSecurityScheme(name: String? = null, description: String = HttpSecurityScheme.DEFAULT_BEARER_DESCRIPTION, bearerFormat: String? = null)

Registers a Bearer HTTP authentication security scheme.

registerDigestAuthSecurityScheme

fun Application.registerDigestAuthSecurityScheme(name: String? = null, description: String = HttpSecurityScheme.DEFAULT_DIGEST_DESCRIPTION)

Registers a Digest HTTP authentication security scheme.

registerJWTSecurityScheme

fun Application.registerJWTSecurityScheme(name: String? = null, description: String = HttpSecurityScheme.DEFAULT_JWT_DESCRIPTION)

Registers a JWT Bearer authentication security scheme.

registerOAuth2SecurityScheme

fun Application.registerOAuth2SecurityScheme(name: String? = null, flows: OAuthFlows, description: String? = OAuth2SecurityScheme.DEFAULT_DESCRIPTION)

Registers an OAuth2 authentication security scheme.

registerOpenIdConnectSecurityScheme

fun Application.registerOpenIdConnectSecurityScheme(name: String? = null, openIdConnectUrl: String, description: String? = OpenIdConnectSecurityScheme.DEFAULT_DESCRIPTION)

Registers an OpenID Connect authentication security scheme.

registerSecurityScheme

fun Application.registerSecurityScheme(providerName: String?, securityScheme: SecurityScheme)

Registers a security scheme for an authentication provider. This metadata will be used to generate the OpenAPI specification. It's not recommended to use this method after the application has started.