kobweb-api/com.varabyte.kobweb.api

Package-level declarations

Types

annotation class Api(val routeOverride: String = "")

An annotation which is used to tag either an API method or (optionally) an API stream object.

class ApiContext(val env: Environment, val req: Request, val data: Data, val logger: Logger)

A container for a bunch of relevant utility classes that may be needed when responding to an API call.

typealias ApiHandler = suspend (ApiContext) -> Unit

class Apis(env: Environment, data: Data, logger: Logger, apiInterceptor: suspend (ApiInterceptorContext) -> Response? = null)

The class which manages all API paths and handlers within a Kobweb project.

An interface for creating an Apis instance.

annotation class PackageMapping(val value: String)

An annotation which allows for mapping the current file's package name to a different URL name.