Type-safe REST API interactions via typed resources, preconfigured HTTP client factory, concise get/post/put/form requests, and HttpTypedResponse with deserialized bodies, reducing boilerplate.
This library provides a simplified and structured way to interact with REST APIs in your Kotlin Multiplatform projects, built on top of Ktor. It offers a type-safe approach to defining API endpoints and streamlines making HTTP requests.
get, post, put and form requests.HttpClient.HttpTypedResponse that includes the deserialized body.Add the dependency to your module's build.gradle.kts file:
dependencies {
implementation("io.github.hussein-al-zuhile:kmp-ktor-client:1.0.2")
}
Create a class for each resource root. Inside, define your specific endpoints as data class or object properties
that implement ApiResource<ResponseBody>.
For requests with a body, use the ApiResourceWithRequest<RequestBody, ResponseBody> interface.
Create a class that inherits from BaseHttpService and inject an HttpClient. This class will contain the functions
that make the actual API calls.
import com.hussein.ktorClient.BaseHttpService
import io.ktor.client.HttpClient
class UserHttpService(client: HttpClient) : BaseHttpService(client) {
= (
resource = UserResource.All(active = active)
)
= (
resource = UserResource.ById(id = id)
)
= post(
resource = UserResource.Create(requestBody = user)
)
}
Use the defaultJsonHttpClient function to create a pre-configured HttpClient. You can customize it further if
needed.
import com.hussein.ktorClient.defaultJsonHttpClient
val myClient = defaultJsonHttpClient(
baseUrl = "https://api.example.com",
isLoggingEnabled = true,
accessToken = "your-bearer-token"
) {
// Extra Ktor configuration can be added here
}
Now, you can instantiate your service and make API calls.
val userService = UserHttpService(myClient)
// Make a GET request
val usersResponse = userService.getUsers(active = true)
if (usersResponse.status.isSuccess()) {
val users: List<User> = usersResponse.body
println("Got users: $users")
}
// Make a POST request
val newUser = User(id = 0, name = "John Doe")
val createResponse = userService.createUser(newUser)
(createResponse.status.isSuccess()) {
println()
}
import com.hussein.ktorClient.ApiResource
import com.hussein.ktorClient.ApiResourceParent
import com.hussein.ktorClient.ApiResourceWithRequest
import io.ktor.resources.Resource
import kotlinx.serialization.Serializable
class UserResource : ApiResourceParent {
data class All(val active: Boolean) : ApiResource<List<User>>
data class ById(val parent: UserResource = UserResource(), val id: Long) : ApiResource<User>
data class Create(val parent: UserResource = UserResource(), override val requestBody: User) :
ApiResourceWithRequest<User, Unit>
}
data class User(val id: Long, val name: String)
Surfaced from shared tags and platforms — no rankings paid for.