README
The easiest HTTP networking library for Kotlin/Android.
You are looking at the documentation for 2.x.y.. If you are looking for the documentation for 1.x.y, checkout the 1.16.0 README.md
- HTTP
GET/POST/PUT/DELETE/HEAD/PATCHrequests in a fluent style interface - Asynchronous and blocking requests
- Download as a file
- Upload files,
Blobs,DataParts asmultipart/form-data - Cancel asynchronous request
- Debug logging / convert to cUrl call
- Deserialization into POJO / POKO
- API Routing
We offer maven and jitpack installations. Maven via bintray only has stable releases but jitpack can be used to build any branch, commit and version.
You can download and install
Fuel with Maven and Gradle. The core package has the following dependencies:
//core
implementation 'com.github.kittinunf.fuel:fuel:<latest-version>'
//packages
implementation 'com.github.kittinunf.fuel:<package>:<latest-version>'
Make sure to include
mavenCentral() in your repositories (jcenter() is deprecated, new releases starting from 2.2.3 are hosted on mavenCentral())repositories {
mavenCentral()
}
Each of the extensions / integrations has to be installed separately.
Package | Description |
|---|---|
Core package | |
Android: Automatically invoke handler on Main Thread when using Android Module | |
repositories {
maven(url = "https://www.jitpack.io") {
name = "jitpack"
}
}
dependencies {
//core
implementation(group = "com.github.kittinunf.fuel", name = "fuel", version = "-SNAPSHOT")
//packages
// replace <package> with the package name e.g. fuel-coroutines
implementation(group = "com.github.kittinunf.fuel", name = "<package>", version = "-SNAPSHOT")
}
or
dependencies {
//core and/or packages
// replace <package> with the package name e.g. fuel-coroutines
listof("fuel", "<package>").forEach {
implementation(group = "com.github.kittinunf.fuel", name = it, version = "-SNAPSHOT")
}
}
groupis made up ofcom.githubas well as username and project namenameis the subproject, this may be any of the packages listed in the installation instructions eg.fuel,fuel-coroutines,fuel-kotlinx-serialization, etcversioncan be the latestmaster-SMAPSHOTor-SNAPSHOTwhich always points at the HEAD or any other branch, tag or commit hash, e.g. as listed on jitpack.io.
We recommend not using
SNAPSHOT builds, but a specific commit in a specific branch (like a commit on master), because your build will then be stable.Have patience when updating the version of fuel or building for the first time as jitpack will build it, and this may cause the request to jitpack to time out. Wait a few minutes and try again (or check the status on jitpack).
NOTE: do not forget to add the
kotlinx repository when using coroutines or serializationJitpack.io also allows to build from
fuel forks. If a fork's username is $yourname,- adjust
grouptocom.github.$yourName.fuel - and look for
versiononhttps://jitpack.io/#$yourName/Fuel
Fuel requests can be made on the
Fuel namespace object, any FuelManager or using one of the String extension methods. If you specify a callback the call is async, if you don't it's blocking.import com.github.kittinunf.fuel.httpGet
import com.github.kittinunf.result.Result
fun main(args: Array<String>) {
val httpAsync = "https://httpbin.org/get"
.httpGet()
.responseString { request, response, result ->
when (result) {
is Result.Failure -> {
val ex = result.getException()
println(ex)
}
is Result.Success -> {
val data = result.get()
println(data)
}
}
}
httpAsync.join()
}
import com.github.kittinunf.fuel.httpGet
import com.github.kittinunf.result.Result;
fun main(args: Array<String>) {
val (request, response, result) = "https://httpbin.org/get"
.httpGet()
.responseString()
when (result) {
is Result.Failure -> {
val ex = result.getException()
println(ex)
}
is Result.Success -> {
val data = result.get()
println(data)
}
}
}
// You can also use Fuel.get("https://httpbin.org/get").responseString { ... }
// You can also use FuelManager.instance.get("...").responseString { ... }
Fuel and the extension methods use the FuelManager.instance under the hood. You can use this FuelManager to change the default behaviour of all requests:FuelManager.instance.basePath = "https://httpbin.org"
"/get"
.httpGet()
.responseString { request, response, result -> /*...*/ }
// This is a GET request to "https://httpbin.org/get"
Check each of the packages documentations or the Wiki for more features, usages and examples. Are you looking for basic usage on how to set headers, authentication, request bodies and more?
fuel: Basic usage is all you need.If you like Fuel, you might also like other libraries of mine;
Last modified 1yr ago