library/xyz.malefic.koven.contract/ApiContractBuilder

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.

Constructors

ApiContractBuilder

constructor(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)

Functions

fun build(): ApiContract<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>

Builds the ApiContract instance.

fun <NewCookieP> cookies(decoder: CookieField<NewCookieP>): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, NewCookieP>

Sets the cookie parameter decoder.

fun get(): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>

Sets the HTTP method to GET.

fun method(httpMethod: HttpMethod): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>

Sets the HTTP method.

fun <NewPathP> path(decoder: PathField<NewPathP>): ApiContractBuilder<Req, Res, ReqH, ResH, NewPathP, QueryP, CookieP>

Sets the path parameter decoder.

fun post(): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>

Sets the HTTP method to POST.

fun protected(): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>

Marks the endpoint as requiring authentication.

fun <NewQueryP> query(decoder: QueryField<NewQueryP>): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, NewQueryP, CookieP>

Sets the query parameter decoder.

fun requestFormat(format: BodyFormat<Req>): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>

Sets the request body format.

fun <NewReqH> requestHeaders(decoder: HeaderField<NewReqH>): ApiContractBuilder<Req, Res, NewReqH, ResH, PathP, QueryP, CookieP>

Sets the request header decoder.

fun responseFormat(format: BodyFormat<Res>): ApiContractBuilder<Req, Res, ReqH, ResH, PathP, QueryP, CookieP>

Sets the response body format.

responseHeaders

fun <NewResH> responseHeaders(decoder: HeaderField<NewResH>): ApiContractBuilder<Req, Res, ReqH, NewResH, PathP, QueryP, CookieP>

Sets the response header decoder.