library/xyz.malefic.koven.contract

Package-level declarations

Types

abstract class ApiContract<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>(val path: String, val httpMethod: HttpMethod = HttpMethod.POST, val requestHeaderDecoder: HeaderField<ReqH> = Empty as HeaderField<ReqH>, val responseHeaderDecoder: HeaderField<ResH> = Empty as HeaderField<ResH>, val pathDecoder: PathField<PathP> = Empty as PathField<PathP>, val queryDecoder: QueryField<QueryP> = Empty as QueryField<QueryP>, val cookieDecoder: CookieField<CookieP> = Empty as CookieField<CookieP>, val requestFormat: BodyFormat<Req>, val responseFormat: BodyFormat<Res>, val isProtected: Boolean = false)

A contract for an API endpoint shared between the client and server.

ApiContractBuilder

class ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>(path: String, httpMethod: HttpMethod = HttpMethod.POST, requestHeaderDecoder: HeaderField<ReqH>, responseHeaderDecoder: HeaderField<ResH>, pathDecoder: PathField<PathP>, queryDecoder: QueryField<QueryP>, cookieDecoder: CookieField<CookieP>, requestFormat: BodyFormat<Req>, responseFormat: BodyFormat<Res>, isProtected: Boolean = false)

A builder for ApiContract types.

data class ApiResponse<Res, ResH>(val status: Int = 200, val body: Res, val headers: ResH, val cookies: List<Cookie> = emptyList())

A wrapper for the response body and its header(s).

object BinaryFormat : BodyFormat<ByteArray>

A BodyFormat for binary bodies.

interface BodyFormat<T>

Defines how a type T is transformed for transmission.

FormUrlEncodedFormat

object FormUrlEncodedFormat : BodyFormat<Map<String, List<String>>>

A BodyFormat for application/x-www-form-urlencoded bodies.

object HtmlFormat : BodyFormat<String>

A BodyFormat for HTML bodies.

enum HttpMethod : Enum<HttpMethod>

Common HTTP methods for API contracts.

class JsonFormat<T>(serializer: KSerializer<T>) : BodyFormat<T>

A BodyFormat that uses JsonSerializer to encode and decode values.

PlainTextFormat

object PlainTextFormat : BodyFormat<String>

A BodyFormat for plain text bodies.

class ProtoBufFormat<T>(serializer: KSerializer<T>) : BodyFormat<T>

A BodyFormat that uses ProtoBufSerializer to encode and decode values.

object UnitFormat : BodyFormat<Unit>

A BodyFormat for Unit bodies.

object XmlFormat : BodyFormat<String>

A BodyFormat for XML bodies.

Properties

val HealthContract: ApiContract<Unit, String, Empty, Empty, Empty, Empty, Empty>

A contract for the common "health" endpoint.

val PingContract: ApiContract<Unit, String, Empty, Empty, Empty, Empty, Empty>

A contract for the common "ping" endpoint.

SecurePingContract

val SecurePingContract: ApiContract<Unit, String, Empty, Empty, Empty, Empty, Empty>

A contract for an example "auth/ping" endpoint.

Functions

inline fun <Req, Res> apiContract(path: String): ApiContractBuilder<Req, Res, Empty, Empty, Empty, Empty, Empty>

Entry point for creating an ApiContract via builder.

fun <Req, Res, ReqH, ResH, PathP, QueryP, CookieP> ApiContract<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>.response(status: Int = 200, block: ApiResponse.Companion.Builder<Res, ResH>.() -> Unit): ApiResponse<Res, ResH>

Creates an ApiResponse for this contract with a DSL-type Builder.