Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kittinunf/fuel
The easiest HTTP networking library for Kotlin/Android
https://github.com/kittinunf/fuel
android http-client kotlin networking rest rxjava
Last synced: 2 days ago
JSON representation
The easiest HTTP networking library for Kotlin/Android
- Host: GitHub
- URL: https://github.com/kittinunf/fuel
- Owner: kittinunf
- License: mit
- Created: 2015-06-04T04:03:33.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:10:47.000Z (about 1 month ago)
- Last Synced: 2024-10-29T11:27:11.742Z (about 1 month ago)
- Topics: android, http-client, kotlin, networking, rest, rxjava
- Language: Kotlin
- Homepage: https://fuel.gitbook.io/documentation/
- Size: 2.5 MB
- Stars: 4,566
- Watchers: 76
- Forks: 430
- Open Issues: 91
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin - fuel - The easiest HTTP networking library for Kotlin/Android (Libraries)
- awesome-kotlin-multiplatform - fuel - The easiest HTTP networking library for Kotlin backed by Kotlinx Coroutines. (Libraries / Network)
README
# Fuel
[](http://kotlinlang.org)
[](https://search.maven.org/search?q=com.github.kittinunf.fuel)
[](https://ktlint.github.io)
[](https://github.com/kittinunf/fuel/actions/workflows/main.yml)
[](https://codecov.io/gh/kittinunf/fuel/branch/main)
The easiest HTTP networking library for Kotlin backed by Kotlinx Coroutines.
## Migration
From 3.x onwards, we are using [main](https://github.com/kittinunf/fuel/tree/main) as our new base branch. If you are finding the old version [2.x](https://github.com/kittinunf/fuel/tree/2.x), please take a look at our old branch.
## Download
### For release version
```kotlin
implementation("com.github.kittinunf.fuel:fuel:3.0.0-alpha04")
```
## Quick Start
use the `any http method` [suspend](https://kotlinlang.org/docs/reference/coroutines/basics.html) function:
```kotlin
runBlocking {
val string: String = Fuel.get("https://publicobject.com/helloworld.txt").body.string()
println(string)
}
runBlocking {
val string: String = "https://publicobject.com/helloworld.txt".httpGet().body.string()
println(string)
}
runBlocking {
val fuel = FuelBuilder().build()
val string: String = fuel.get(request = { url = "https://publicobject.com/helloworld.txt" }).body.string()
println(string)
}
```
## Custom Configuration
JVM uses [OkHttpClient](https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/) configurations
```kotlin
val fuel = FuelBuilder().config(OKHttpClient()).build()
val string = fuel.get(request = { url = "https://publicobject.com/helloworld.txt" }).body.string()
```
Apple uses [NSURLSessionConfiguration](https://developer.apple.com/documentation/foundation/nsurlsessionconfiguration)
```kotlin
val fuel = FuelBuilder().config(NSURLSessionConfiguration.defaultSessionConfiguration).build()
val string = fuel.get(request = { url = "https://publicobject.com/helloworld.txt" }).body.string()
```
Please note it will throw Exceptions. Make sure you catch it on the production apps.
Fuel requires Java 8 byte code.
## Requirements
- If you are using Android, It needs to be Android 5+.
- Java 8+
## R8 / Proguard
Fuel is fully compatible with R8 out of the box and doesn't require adding any extra rules.
If you use Proguard, you may need to add rules for [Coroutines](https://github.com/Kotlin/kotlinx.coroutines/blob/master/kotlinx-coroutines-core/jvm/resources/META-INF/proguard/coroutines.pro), [OkHttp](https://github.com/square/okhttp/blob/master/okhttp/src/main/resources/META-INF/proguard/okhttp3.pro) and [Okio](https://github.com/square/okio/blob/master/okio/src/jvmMain/resources/META-INF/proguard/okio.pro).
If you use the fuel-serialization modules, you may need to add rules for [Serialization](https://github.com/Kotlin/kotlinx.serialization#androidjvm).
If you use the fuel-moshi modules, you may need to add rules for [Moshi](https://github.com/square/moshi/blob/master/moshi/src/main/resources/META-INF/proguard/moshi.pro) and [Moshi-Kotlin](https://github.com/square/moshi/blob/master/kotlin/reflect/src/main/resources/META-INF/proguard/moshi-kotlin.pro)
## Other libraries
If you like Fuel, you might also like other libraries of mine;
- [Result](https://github.com/kittinunf/Result) - The modelling for success/failure of operations in Kotlin
- [Fuse](https://github.com/kittinunf/Fuse) - A simple generic LRU memory/disk cache for Android written in Kotlin
- [Forge](https://github.com/kittinunf/Forge) - Functional style JSON parsing written in Kotlin
- [ReactiveAndroid](https://github.com/kittinunf/ReactiveAndroid) - Reactive events and properties with RxJava for Android SDK
## Credits
Fuel brought to you by [contributors](https://github.com/kittinunf/Fuel/graphs/contributors).
## Licenses
Fuel released under the [MIT](https://opensource.org/licenses/MIT) license.