https://github.com/uakihir0/khttpclient
Kotlin multiplatform simple http request library.
https://github.com/uakihir0/khttpclient
kotlin kotlin-library kotlin-multiplatform
Last synced: about 2 months ago
JSON representation
Kotlin multiplatform simple http request library.
- Host: GitHub
- URL: https://github.com/uakihir0/khttpclient
- Owner: uakihir0
- License: mit
- Created: 2023-12-19T16:09:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-06T12:03:43.000Z (12 months ago)
- Last Synced: 2024-07-06T13:25:59.767Z (12 months ago)
- Topics: kotlin, kotlin-library, kotlin-multiplatform
- Language: Kotlin
- Homepage:
- Size: 220 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [日本語](./docs/README_ja.md)
# kHttpClient
![badge][badge-js]
![badge][badge-jvm]
![badge][badge-ios]
![badge][badge-mac]
![badge][badge-windows]
![badge][badge-linux]
**This library is designed for making simple Http requests in [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html).**
It relies on Ktor Client and is implemented as a wrapper for it. Therefore,
this library is available for use in Kotlin Multiplatform as long as the platform is supported by Ktor Client.
## Engine Selection
Ktor Client provides several implementations of HttpClient engines for each platform.
In this library, the following engines are selected for each platform.
If you want to switch the engine, remove it from the dependencies and add another one.
However, the behavior in that case cannot be guaranteed.
- Apple: Darwin
- JVM: OkHttp
- Windows: WinHttp
- Linux: Curl
In a Linux environment, WebSocket cannot be used due to the specifications of the Engine.
If you want to use WebSocket, please change the dependencies by removing `curl` and adding `cio`.
Note that in this case, some servers may be inaccessible due to partial lack of TLS support.
For more details about the engine, please refer to the [official Ktor documentation](https://ktor.io/docs/client-engines.html).
## Usage
### Stable
```kotlin:build.gradle.kts
repositories {
mavenCentral()
}
dependencies {
+ implementation("work.socialhub:khttpclient:0.0.5")
}
```
### Snapshot
```kotlin:build.gradle.kts
repositories {
mavenCentral()
+ maven { url = uri("https://repo.repsy.io/mvn/uakihir0/public") }
}
dependencies {
+ implementation("work.socialhub:khttpclient:0.0.6-SNAPSHOT")
}
```
### GET
To perform a GET request with query parameters, you can write it as follows:
```kotlin
val response = HttpRequest()
.url("https://httpbin.org/get")
.query("key1", "value1")
.query("key2", "value2")
.get()
```
### POST
To perform a POST request with form data and files, you can write it as follows:
```kotlin
val response = HttpRequest()
.url("https://httpbin.org/post")
.param("key", "value")
.file("file", "test.txt", "content".toByteArray())
.post()
```
To perform a POST request with a JSON string as the body, you can write it as follows:
```kotlin
val response = HttpRequest()
.url("https://httpbin.org/post")
.json("""{"key": "value"}""")
.post()
```
For detailed usage, refer to the test code.
## License
MIT License
## Author
[Akihiro Urushihara](https://github.com/uakihir0)
[badge-android]: http://img.shields.io/badge/-android-6EDB8D.svg
[badge-android-native]: http://img.shields.io/badge/support-[AndroidNative]-6EDB8D.svg
[badge-wearos]: http://img.shields.io/badge/-wearos-8ECDA0.svg
[badge-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg
[badge-js]: http://img.shields.io/badge/-js-F8DB5D.svg
[badge-js-ir]: https://img.shields.io/badge/support-[IR]-AAC4E0.svg
[badge-nodejs]: https://img.shields.io/badge/-nodejs-68a063.svg
[badge-linux]: http://img.shields.io/badge/-linux-2D3F6C.svg
[badge-windows]: http://img.shields.io/badge/-windows-4D76CD.svg
[badge-wasm]: https://img.shields.io/badge/-wasm-624FE8.svg
[badge-apple-silicon]: http://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg
[badge-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg
[badge-mac]: http://img.shields.io/badge/-macos-111111.svg
[badge-watchos]: http://img.shields.io/badge/-watchos-C0C0C0.svg
[badge-tvos]: http://img.shields.io/badge/-tvos-808080.svg