In this tutorial, we will learn how to use OkHttp for HTTP requests while consuming APIs.
OkHttp is an HTTP client which will do HTTP efficiently by loading faster and saving bandwidth. Using OkHttp is easy. Its request/response API is designed with fluent builders and immutability. It supports both synchronous blocking calls and async calls with callbacks.
Setup the OkHttp dependency:
If we are using the external Jar file, download the jar from okhttp maven.
Follow this tutorial for setting up the Jar file How to add external jar or library on IntelliJ IDEA project
Setup in maven project:
Add in pom.xml
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>4.10.0</version>
</dependency>
Setup in Gradle project:
Add in build.gradle under "dependencies"
dependencies {
//other dependencies
compile("com.squareup.okhttp3:okhttp:4.10.0")
}
Implementation:
Let's create a sample java class HttpClient.java and set up the OkHttp3 client.
import okhttp3.MediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody
import okhttp3.Response
class HttpClient {
public static final MediaType JSON = MediaType.get("application/json; charset=utf-8")
public static Response doGetRequest(url, String apiKey = '') {
Request.Builder requestBuilder = new Request.Builder()
.url(url)
Request request = setHeadersConfig(requestBuilder, apiKey).build();
Response response = getClient().newCall(request).execute()
return response.body().string();
}
public static String doPostRequest(String json, String url, String apiKey = '') {
RequestBody body = RequestBody.create(json, JSON)
Request.Builder requestBuilder = new Request.Builder()
.url(url)
.post(body)
Request request = setHeadersConfig(requestBuilder, apiKey).build();
Response response = getClient().newCall(request).execute()
return response.body().string()
}
public static String doDeleteRequest(String json, String url, String apiKey = '') {
RequestBody body = RequestBody.create(json, JSON)
Request.Builder requestBuilder = new Request.Builder()
.url(url)
.delete(body)
Request request = setHeadersConfig(requestBuilder, apiKey).build();
Response response = getClient().newCall(request).execute()
return response.body().string()
}
private static Request.Builder setHeadersConfig(Request.Builder requestBuilder, String apiKey) {
requestBuilder.header("Content-Type", "application/json")
.header("X-MBX-APIKEY", apiKey)
return requestBuilder
}
private static OkHttpClient getClient() {
return new OkHttpClient()
}
}
This class contains the setup for the post, get and delete request.
Method setHeadersConfig is for setting up the headers we used sample X-MBX-APIKEY header configuration to set the API key. You can use your desired header configuration there.
We can pass the post body by formatting the data in JSON string.
Please don't forget to handle the Exception.
Getting Status Code:
We can get the status code from the Response response object in the above example as below:
Response response = getClient().newCall(request).execute()
int statusCode = response.code()
Using it from Java classes:
All the methods are static so we can simply use it from other java classes as below:
HttpClient.doPostRequest(json, url, apiKey)
