Ktor OpenAPI/Swagger 3 Generator/com.papsign.ktor.openapigen.route.path.auth/OpenAPIAuthenticatedRoute

OpenAPIAuthenticatedRoute

class OpenAPIAuthenticatedRoute<TAuth>(route: Route, provider: CachingModuleProvider = CachingModuleProvider(), val authProvider: AuthProvider<TAuth>) : OpenAPIRoute<OpenAPIAuthenticatedRoute<TAuth>> (source)

Constructors

constructor(route: Route, provider: CachingModuleProvider = CachingModuleProvider(), authProvider: AuthProvider<TAuth>)

Properties

application

val OpenAPIRoute<*>.application: Application

authProvider

val authProvider: AuthProvider<TAuth>

ktorRoute

val ktorRoute: Route

provider

val provider: CachingModuleProvider

Functions

child

open override fun child(route: Route): OpenAPIAuthenticatedRoute<TAuth>

delete

inline fun <TParams : Any, TResponse : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.delete(vararg modules: RouteOpenAPIModule, example: TResponse? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams) -> Unit)

exitAPI

inline fun OpenAPIRoute<*>.exitAPI(crossinline fn: Route.() -> Unit)

get

inline fun <TParams : Any, TResponse : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.get(vararg modules: RouteOpenAPIModule, example: TResponse? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams) -> Unit)

getAcceptMap

fun <R : Any> getAcceptMap(type: KType): List<Pair<ContentType, List<SelectedSerializer>>>

getBodyParser

fun List<SelectedParser>.getBodyParser(contentType: ContentType): BodyParser

getContentTypesMap

fun <B : Any> getContentTypesMap(type: KType): List<Pair<ContentType, List<SelectedParser>>>

getResponseSerializer

fun List<SelectedSerializer>.getResponseSerializer(contentType: ContentType): ResponseSerializer

handle

fun <P : Any, R : Any, B : Any> handle(paramsType: KType, responseType: KType, bodyType: KType, pass: suspend OpenAPIRoute<*>.(pipeline: RoutingContext, responder: Responder, P, B) -> Unit)

handle

inline fun <TParams : Any, TResponse : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.handle(exampleResponse: TResponse? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams) -> Unit)

inline fun <TParams : Any, TResponse : Any, TRequest : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.handle(exampleResponse: TResponse? = null, exampleRequest: TRequest? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams, TRequest) -> Unit)

head

inline fun <TParams : Any, TResponse : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.head(vararg modules: RouteOpenAPIModule, example: TResponse? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams) -> Unit)

mapContentTypes

inline fun <T : OpenAPIModule> mapContentTypes(noinline fn: T.() -> List<ContentType>): List<Pair<ContentType, List<T>>>

patch

inline fun <TParams : Any, TResponse : Any, TRequest : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.patch(vararg modules: RouteOpenAPIModule, exampleResponse: TResponse? = null, exampleRequest: TRequest? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams, TRequest) -> Unit)

post

inline fun <TParams : Any, TResponse : Any, TRequest : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.post(vararg modules: RouteOpenAPIModule, exampleResponse: TResponse? = null, exampleRequest: TRequest? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams, TRequest) -> Unit)

put

inline fun <TParams : Any, TResponse : Any, TRequest : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.put(vararg modules: RouteOpenAPIModule, exampleResponse: TResponse? = null, exampleRequest: TRequest? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams, TRequest) -> Unit)

route

inline fun <TParams : Any, TResponse : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.route(method: HttpMethod, modules: Array<out RouteOpenAPIModule>, exampleResponse: TResponse? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams) -> Unit)

inline fun <TParams : Any, TResponse : Any, TRequest : Any, TAuth> OpenAPIAuthenticatedRoute<TAuth>.route(method: HttpMethod, modules: Array<out RouteOpenAPIModule>, exampleResponse: TResponse? = null, exampleRequest: TRequest? = null, noinline body: suspend OpenAPIPipelineAuthContext<TAuth, TResponse>.(TParams, TRequest) -> Unit)