DomeHTTP Client (WIP)

This project is a Kotlin Multiplatform HTTP Client, totally work-in-progress, implementation is not optimal, code not tested, API not final.

Goals

• Coroutines-based
• Small dependencies and almost reflection-free, inline the most we can (small binary size and low methods count because "Android 64k method limit")
• Make it easy to replace the engine, if needed
• Someday iOS target will work flawlessly

Challenges

• Multi-threading in Native
• Reflection API, maybe compile-time generated, in Native and JS

Installation

repositories {
maven { url "https://dl.bintray.com/hazer/maven" }
}
// Common Module
implementation "io.vithor.libs:dome-http:$last_version"
// Android Module
implementation "io.vithor.libs:dome-http-android:$last_version"
// iOS Module
implementation "io.vithor.libs:dome-http-ios:$last_version" // x86/Simulator
implementation "io.vithor.libs:dome-http-iosArm32:$last_version"
implementation "io.vithor.libs:dome-http-iosArm64:$last_version"
// JVM Module
implementation "io.vithor.libs:dome-http-jvm:$last_version"

Usages

First you need to declare the Client configuration using default provided engines (you can create your own engine):

val dome =DomeClient(engine =OkHttpEngine() /* or NSUrlSessionEngine() */) {
timeouts {
connect =30.seconds
read =30.seconds
write =30.seconds
}
serialization(KotlinxSerializer(strict =true)) {
// Unfortunately, right now to work also in iOS, we need to declare all Top Serializers manually.
register(Todo.serializer())
register(TodoCreate.serializer())
}
}

Then we can make requests as:

// GET requestval todo = dome.get<Todo>("https://jsonplaceholder.typicode.com/todos/1").await(Dispatchers.IO)

// GET request with configurationsval todos:List<Todo> = dome.get<Todo>("https://jsonplaceholder.typicode.com/todos") {
headers +=mapOf(
"X-Header-Name" to "header value"
)
addHeader("X-Another-Header", "Another value")
params =listOf(
"excerpt" to "yes",
"user" to "Vithorio",
"language" to "pt-BR"
)
addQueryParam("another-param", "Mage")
}.asList<Todo>().await()
// Because we have no Reflection API in iOS, we cannot write only dome.get<List<Todo>> and work with Kotlinx.Serialization, that's why `asList` exists

// POST request with Jsonval todoCreated = dome.post<TodoCreate>("https://jsonplaceholder.typicode.com/todos") {
jsonOf(
TodoCreate(
userId =1,
title ="Just a POST test",
body ="This is what is missing to do"
)
)
}.await()

// POST request with form url encodedval todoCreated = dome.post<TodoCreate>("https://jsonplaceholder.typicode.com/todos") {
formOf(
"userId" to "1",
"title" to "Just a POST test",
"body" to "This is what is missing to do"
)
// or
form(
listOf(
"userId" to "1",
"title" to "Just a POST test",
"body" to "This is what is missing to do"
)
)
}.await()

Credits

This project takes a lot of inspiration from ktorio/ktor and rybalkinsd/kohttp. I started building this project because Ktor Client in Android was heavy, so I made this initially as a study project and as an alternative with lower footprint.