routers-ktor/dev.kaccelero.routers

Package-level declarations

Types

abstract class AbstractChildModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any, ParentModel, ParentId>(val modelTypeInfo: <Error class: unknown class>, val createPayloadTypeInfo: <Error class: unknown class>, val updatePayloadTypeInfo: <Error class: unknown class>, val controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>, val controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>>, val parentRouter: <Error class: unknown class><ParentModel, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>?, route: String? = null, id: String? = null, prefix: String? = null)

AbstractModelRouter

abstract class AbstractModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>>, route: String? = null, id: String? = null, prefix: String? = null) : AbstractChildModelRouter<Model, Id, CreatePayload, UpdatePayload, <Error class: unknown class>, Unit>

AdminChildModelRouter

open class AdminChildModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any, ParentModel, ParentId>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>>, parentRouter: <Error class: unknown class><ParentModel, ParentId, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>?, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, val listTemplate: String? = null, val getTemplate: String? = null, val createTemplate: String? = null, val updateTemplate: String? = null, val deleteTemplate: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : TemplateChildModelRouter<Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>

AdminModelRouter

open class AdminModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>>, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, listTemplate: String? = null, getTemplate: String? = null, createTemplate: String? = null, updateTemplate: String? = null, deleteTemplate: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : AdminChildModelRouter<Model, Id, CreatePayload, UpdatePayload, <Error class: unknown class>, Unit>

AdminUnitRouter

open class AdminUnitRouter(controller: <Error class: unknown class> = UnitController, controllerClass: KClass<out <Error class: unknown class>> = UnitController::class, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, route: String? = null, prefix: String? = null) : AdminModelRouter<<Error class: unknown class>, Unit, Unit, Unit>

APIChildModelRouter

open class APIChildModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any, ParentModel, ParentId>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>>, parentRouter: <Error class: unknown class><ParentModel, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>?, route: String? = null, id: String? = null, prefix: String? = null) : AbstractChildModelRouter<Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>

APIModelRouter

open class APIModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>>, route: String? = null, id: String? = null, prefix: String? = null) : APIChildModelRouter<Model, Id, CreatePayload, UpdatePayload, <Error class: unknown class>, Unit>

APIUnitRouter

open class APIUnitRouter(controller: <Error class: unknown class> = UnitController, controllerClass: KClass<out <Error class: unknown class>>, route: String? = null, prefix: String? = null) : APIModelRouter<<Error class: unknown class>, Unit, Unit, Unit>

ControllerRoute

data class ControllerRoute(val type: <Error class: unknown class>, val path: String?, val method: <Error class: unknown class>?, val annotations: List<Annotation>, val parameters: List<<Error class: unknown class>>, val returnType: KType, val handler: suspend (args: Map<<Error class: unknown class>, Any?>) -> Any?)

ILocalizedTemplateRouter

interface ILocalizedTemplateRouter

KtorCall

class KtorCall(val call: <Error class: unknown class>)

KtorRoute

class KtorRoute(val route: <Error class: unknown class>)

LocalizedAdminChildModelRouter

open class LocalizedAdminChildModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any, ParentModel, ParentId>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>>, parentRouter: <Error class: unknown class><ParentModel, ParentId, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>?, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, getLocaleForCallUseCase: <Error class: unknown class>, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, listTemplate: String? = null, getTemplate: String? = null, createTemplate: String? = null, updateTemplate: String? = null, deleteTemplate: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : AdminChildModelRouter<Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId> , ILocalizedTemplateRouter

LocalizedAdminModelRouter

open class LocalizedAdminModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>>, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, val getLocaleForCallUseCase: <Error class: unknown class>, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, listTemplate: String? = null, getTemplate: String? = null, createTemplate: String? = null, updateTemplate: String? = null, deleteTemplate: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : AdminModelRouter<Model, Id, CreatePayload, UpdatePayload> , ILocalizedTemplateRouter

LocalizedAdminUnitRouter

open class LocalizedAdminUnitRouter(controller: <Error class: unknown class> = UnitController, controllerClass: KClass<out <Error class: unknown class>> = UnitController::class, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, val getLocaleForCallUseCase: <Error class: unknown class>, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, route: String? = null, prefix: String? = null) : AdminUnitRouter, ILocalizedTemplateRouter

LocalizedTemplateChildModelRouter

open class LocalizedTemplateChildModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any, ParentModel, ParentId>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>>, parentRouter: <Error class: unknown class><ParentModel, ParentId, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>?, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, getLocaleForCallUseCase: <Error class: unknown class>, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : TemplateChildModelRouter<Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId> , ILocalizedTemplateRouter

LocalizedTemplateModelRouter

open class LocalizedTemplateModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>>, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, val getLocaleForCallUseCase: <Error class: unknown class>, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : TemplateModelRouter<Model, Id, CreatePayload, UpdatePayload> , ILocalizedTemplateRouter

LocalizedTemplateUnitRouter

open class LocalizedTemplateUnitRouter(controller: <Error class: unknown class> = UnitController, controllerClass: KClass<out <Error class: unknown class>> = UnitController::class, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, val getLocaleForCallUseCase: <Error class: unknown class>, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, route: String? = null, prefix: String? = null) : TemplateUnitRouter, ILocalizedTemplateRouter

OpenAPIRouter

class OpenAPIRouter(prefix: String = "/docs", generator: <Error class: unknown class> = DefaultGenerator(), codegen: <Error class: unknown class> = StaticHtml2Codegen(), opts: <Error class: unknown class> = ClientOptInput())

SwaggerOpenAPI

class SwaggerOpenAPI(val openAPI: <Error class: unknown class>)

TemplateChildModelRouter

open class TemplateChildModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any, ParentModel, ParentId>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>>, parentRouter: <Error class: unknown class><ParentModel, ParentId, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>?, val respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, val errorTemplate: String? = null, val redirectUnauthorizedToUrl: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : AbstractChildModelRouter<Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>

TemplateModelRouter

open class TemplateModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>>, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, route: String? = null, id: String? = null, prefix: String? = null) : TemplateChildModelRouter<Model, Id, CreatePayload, UpdatePayload, <Error class: unknown class>, Unit>

TemplateUnitRouter

open class TemplateUnitRouter(controller: <Error class: unknown class> = UnitController, controllerClass: KClass<out <Error class: unknown class>> = UnitController::class, respondTemplate: suspend <Error class: unknown class>.(String, Map<String, Any?>) -> Unit, errorTemplate: String? = null, redirectUnauthorizedToUrl: String? = null, route: String? = null, prefix: String? = null) : TemplateModelRouter<<Error class: unknown class>, Unit, Unit, Unit>

WebSocketAPIChildModelRouter

open class WebSocketAPIChildModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any, ParentModel, ParentId>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>>, parentRouter: <Error class: unknown class><ParentModel, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>?, route: String? = null, id: String? = null, prefix: String? = null) : APIChildModelRouter<Model, Id, CreatePayload, UpdatePayload, ParentModel, ParentId>

WebSocketAPIModelRouter

open class WebSocketAPIModelRouter<Model, Id, CreatePayload : Any, UpdatePayload : Any>(modelTypeInfo: <Error class: unknown class>, createPayloadTypeInfo: <Error class: unknown class>, updatePayloadTypeInfo: <Error class: unknown class>, controller: <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>, controllerClass: KClass<out <Error class: unknown class><Model, Id, CreatePayload, UpdatePayload>>, route: String? = null, id: String? = null, prefix: String? = null) : WebSocketAPIChildModelRouter<Model, Id, CreatePayload, UpdatePayload, <Error class: unknown class>, Unit>

WebSocketAPIUnitRouter

open class WebSocketAPIUnitRouter(controller: <Error class: unknown class> = UnitController, controllerClass: KClass<out <Error class: unknown class>>, route: String? = null, prefix: String? = null) : WebSocketAPIModelRouter<<Error class: unknown class>, Unit, Unit, Unit>

Properties

isList

val KType.isList: Boolean

underlyingType

val KType.underlyingType: KType?

Functions

createRoutes

fun <Error class: unknown class>.createRoutes(root: <Error class: unknown class>, openAPI: <Error class: unknown class>? = null): <Error class: unknown class>

description

fun <Error class: unknown class>.description(type: KType): <Error class: unknown class>

errorSchema

fun <Error class: unknown class>.errorSchema(key: String): <Error class: unknown class>

get

suspend fun <Error class: unknown class><out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>, out <Error class: unknown class>>.get(call: <Error class: unknown class>): <Error class: unknown class>

info

fun <Error class: unknown class>.info(build: <Error class: unknown class>.() -> Unit): <Error class: unknown class>

mediaType

fun <Error class: unknown class>.mediaType(name: String, build: <Error class: unknown class>.() -> Unit): <Error class: unknown class>

path

fun <Error class: unknown class>.path(path: String, build: <Error class: unknown class>.() -> Unit): <Error class: unknown class>

requestBody

fun <Error class: unknown class>.requestBody(build: <Error class: unknown class>.() -> Unit): <Error class: unknown class>

response

fun <Error class: unknown class>.response(name: String, build: <Error class: unknown class>.() -> Unit = {}): <Error class: unknown class>

route

fun <Error class: unknown class>.route(method: <Error class: unknown class>, path: String, build: <Error class: unknown class>.() -> Unit): <Error class: unknown class>

schema

fun <Error class: unknown class>.schema(type: KType): <Error class: unknown class><Any>

fun <Error class: unknown class>.schema(type: KType, openAPI: <Error class: unknown class>): <Error class: unknown class>