ktkit-ktor-httpclient/io.github.smyrgeorge.ktkit.ktor.httpclient.impl/RestClient

RestClient

class RestClient(json: Json, baseUrl: String = "", client: HttpClient = HttpClientFactory.create(json = json), mapError: context(Raise<RestClientErrorSpec>) suspend HttpResponse.() -> RestClientErrorSpec) : AbstractRestClient(source)

Constructors

RestClient

constructor(json: Json, baseUrl: String = "", client: HttpClient = HttpClientFactory.create(json = json), mapError: context(Raise<RestClientErrorSpec>) suspend HttpResponse.() -> RestClientErrorSpec)

Properties

baseUrl

val baseUrl: String

The base URL used to construct full request URIs.

client

val client: HttpClient

The HttpClient responsible for executing HTTP requests.

json

val json: Json

The instance of Json for JSON serialization and deserialization.

mapError

val mapError: context(Raise<RestClientErrorSpec>) suspend HttpResponse.() -> RestClientErrorSpec

A function transforming an HttpResponse into a RestClientErrorSpec

Functions

delete

context(_: Raise<RestClientErrorSpec>)
inline suspend fun <T> delete(uri: String, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T

get

context(r: Raise<RestClientErrorSpec>)
inline suspend fun <T> get(uri: String, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T

head

context(r: Raise<RestClientErrorSpec>)
inline suspend fun <T> head(uri: String, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T

options

context(r: Raise<RestClientErrorSpec>)
inline suspend fun <T> options(uri: String, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T

patch

context(_: Raise<RestClientErrorSpec>)
inline suspend fun <T, B> patch(uri: String, body: B? = null, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T

post

context(_: Raise<RestClientErrorSpec>)
inline suspend fun <T, B> post(uri: String, body: B, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T

postMultipart

context(_: Raise<RestClientErrorSpec>)
inline suspend fun <T> postMultipart(uri: String, data: ByteArray, fileName: String = "file", contentType: ContentType = ContentType.Application.OctetStream, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T

put

context(_: Raise<RestClientErrorSpec>)
inline suspend fun <T, B> put(uri: String, body: B? = null, crossinline builder: HttpRequestBuilder.() -> Unit = {}): T