Type-safe HTTP client simplifies HTTP requests with coroutine support, interface-based service declarations, and flexible configuration. Offers suspend functions, post requests, dynamic URLs, and custom serialization.
//The following code is equivalent to: https://xxx/getUser?userId=$userId
suspend fun getUser(userId: Int): User
or
fun getUser(userId: Int): Call<User>
//In Coroutine
val user = hf.getUser(0).await()
//In Compose used:
val user by remember { hf.getUser(0).toState() }
Text("UserName=${user?.name}")
A type-safe HTTP client for Kotlin Multiplatform.
Step 1.add dependencies:
version
=
plugins {
...
id("com.google.devtools.ksp") version "1.8.20-1.0.10"//this,The left 1.8.20 corresponds to your the Kotlin version,more version: https://github.com/google/ksp/releases
}
dependencies {
...
implementation("io.github.ltttttttttttt:LazyPeopleHttp-lib:$version")//this,such as 1.1.1
ksp("io.github.ltttttttttttt:LazyPeopleHttp:$version")//this,such as 1.1.1
}
plugins {
...
id("com.google.devtools.ksp") version "1.8.20-1.0.10"
}
...
val commonMain by getting {
dependencies {
...
api("io.github.ltttttttttttt:LazyPeopleHttp-lib:$version")//this,such as 1.1.1
}
}
...
dependencies {
add("kspCommonMainMetadata", "io.github.ltttttttttttt:LazyPeopleHttp:$version")
}
Step 2.interface declaration:
Step 3.interface use:
//Configure the client of ktor
private val client = HttpClient {
defaultRequest {
url()
}
}
config = LazyPeopleHttpConfig(client)
hf = HttpFunctions::.createService(config)
hf.postB().enqueue()
hf.suspendGetB() or hf.postB().await()
remember { hf.().toState() }
Step 4.Custom configuration(Optional):
Step 5.R8/Proguard(Optional):
# The name used in your customized [CallAdapter]
interface HttpFunctions : GetFuns {
//Standard post request statement,url=post/postB
fun postB( t: String): Call<UserBean>
//The lazy people post request statement will treat the method name as a url,url=postC
fun post_postC(name: String): Call<String>
//suspend post request statement,url=postA
suspend fun post_postA(t: String): String
//Configure dynamic urls
//Add static request headers
fun getD(
url: String,
map: Map<String, String?>//can be more flexible, post use @FieldMap,
): Call<String?>
}
//All methods in this file will automatically add an infix
interface GetHf {
//url=get/getC
fun getC2(name: String): Call<String>
//url=get/getB
fun getB(name: String): Call<String>
}
/*
* Current LazyPeopleHttpService Class Global Configuration
* [client]Ktor request client
* [serializer]serializer
* [encryptor]encryptor
* [defaultRequestMethod]Default request method (without annotation)
* [onSuspendError]Called when the suspend function throws an exception
* [onRequest]Successfully constructed the request, but called before sending the request
* [onResponse]Called after request
*/
class LazyPeopleHttpConfig(...) {
/**
* Add an adapter for constructing the return value object of a network request
* After adding, you can declare it like this: fun getUser(): Flow<UserBean>
*/
fun addCallAdapter()
/**
* Hook suspend response
*/
fun addSuspendHook()
}
//Modify the configuration of an interface separately
hf.postB("123").config {
//this is HttpRequestBuilder
}.enqueue()
ksp {
//Enable runtime configuration to obtain all annotations, call [RequestInfo # functionAnnotations] when not enabled and always return null
//arg("getFunAnnotationsWithLazyPeopleHttp", "true")
//Rules for customizing output files, refer to [CustomizeOutputFileBean], Need a JSON file, The content is List<CustomizeOutputFile>
//arg("customizeOutputFileWithLazyPeopleHttp", "${project.projectDir.absoluteFile}/customizeOutputFile.json")
//When using the name of a method as a URL, replace a value with [functionReplaceTo]
//arg("functionReplaceFromWithLazyPeopleHttp", "_")
//When using the method name as a URL, replace [functionReplaceFrom] with the set value
//arg("functionReplaceToWithLazyPeopleHttp", "/")
}
Surfaced from shared tags and platforms — no rankings paid for.