Unirest Java Tutorial | Java Http Client

UNIREST: AGENDA
1. Introduction to Unirest: (Link: https://interviewbubble.com/unirest-java-tutorial/)
➤ Why Unirest needed?
➤ What is UniRest?
➤ Features of Unirest
➤ Availability and support for Unirest
2. Installation and Setup
3. Features Details and how to use:
➤ Make GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS requests
➤ Both syncronous and asynchronous (non-blocking) requests
➤ Supports form parameters, file uploads and custom body entities
➤ Easily add route parameters without ugly string concatenations
➤ Supports gzip
➤ Supports Basic Authentication natively
➤ Customizable timeout, concurrency levels and proxy settings
➤ Customizable default headers for every request (DRY)
➤ Customizable HttpClient and HttpAsyncClient implementation
➤ Automatic JSON parsing into a native object for JSON responses
➤ Customizable binding, with mapping from response body to java Object
4. Demo Project: Java REST Client Using Unirest Java API
https://interviewbubble.com/unirest-java-tutorial/

INTRODUCTION TO UNIREST: WHY
UNIREST NEEDED?
private static void sendGET() throws IOException {
URL obj = new URL(GET_URL);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
con.setRequestProperty("User-Agent", USER_AGENT);
int responseCode = con.getResponseCode();
System.out.println("GET Response Code :: " + responseCode);
if (responseCode == HttpURLConnection.HTTP_OK) { // success
BufferedReader in = new BufferedReader(new InputStreamReader(
con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
// print result
System.out.println(response.toString());
} else {
System.out.println("GET request not worked”);
}

EQUIVALENT UNIREST CODE
final HttpResponse<String> response = Unirest.get("http://httpbin.org/get").asString();
Advantages:
1. Less code: good for rapid software development
2. Easy to use: easy to debug
3. Support Available in multiple languages
4. Method level access available
5. Automatic JSON parsing into a native object for JSON responses
6. Customizable binding, with mapping from response body to java Object

WHAT IS UNIREST?
Unirest is lightweight HTTP request client libraries available in multiple
languages including Java, .NET, Ruby, Node, Objective-C, etc.
Goal:
Unirest aims to simplify making HTTP REST requests.
Backend: Apache Http-client
It is Same as JDBI on top of JDBC

FEATURES OF UNIREST
• Make GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS requests
• Both syncronous and asynchronous (non-blocking) requests
• It supports form parameters, file uploads and custom body entities
• Easily add route parameters without ugly string concatenations
• Supports gzip
• Supports Basic Authentication natively
• Customizable timeout, concurrency levels and proxy settings
• Customizable default headers for every request (DRY)
• Customizable HttpClient and HttpAsyncClient implementation
• Automatic JSON parsing into a native object for JSON responses
• Customizable binding, with mapping from response body to java Object

AVAILABILITY AND SUPPORT FOR
UNIREST
.

Installation and Setup
With Maven
You can use Maven by including the library:
There are dependencies for Unirest-Java, these should be already installed, and they are as follows:
1. httpclient
2. httpasyncclient
.

MAKE GET, POST, PUT, PATCH,
DELETE, HEAD, OPTIONS REQUESTS
➤ GET:
final HttpResponse<String> response = Unirest.get("http://httpbin.org/get").asString();
System.out.println( response.getBody() );
➤ POST:
HttpResponse<String> jsonResponse = Unirest.post("http://httpbin.org/post")
.header("accept", "application/json")
.queryString("apiKey", "123")
.field("parameter", "value")
.field("foo", "bar")
.asString();
➤ PUT:
final HttpResponse<String> response = Unirest.put(“http://httpbin.org/put").asString();
➤ DELETE:
final HttpResponse<String> response = Unirest.delete("http://httpbin.org/delete").asString();
➤ HEAD:
final HttpResponse<String> response = Unirest.head("http://httpbin.org/head").asString();

SYNCRONOUS & ASYNCHRONOUS
(NON-BLOCKING) REQUESTS
Type to enter a caption.

SYNCRONOUS & ASYNCHRONOUS
(NON-BLOCKING) REQUESTS
Sometimes, well most of the time, you want your application to be asynchronous and not block, Unirest supports this in Java
using anonymous callbacks, or direct method placement:
using java.util.concurrent.Future and callback methods:
Future<HttpResponse<JsonNode>> future = Unirest.post("http://httpbin.org/post")
.field("param1", "value1")
.field("param2", "value2")
.asJsonAsync(new Callback<JsonNode>() {
public void failed(UnirestException e) {
System.out.println("The request has failed");
}
public void completed(HttpResponse<JsonNode> response) {
int code = response.getStatus();
Map<String, String> headers = response.getHeaders();
JsonNode body = response.getBody();
InputStream rawBody = response.getRawBody();
}

FORM PARAMETERS, FILE UPLOADS
AND CUSTOM BODY ENTITIES
➤ Form Params
➤ File Upload:
➤ Custom body
.
.
.

ROUTE PARAMETERS
Sometimes you want to add dynamic parameters in the URL, you can easily do that by
adding a placeholder in the URL, and then by setting the route parameters with
the routeParam function, like:
Type to enter a caption.

SUPPORTS GZIP
➤ Using setDefaultHeader method we can use GZIP.
Unirest.setDefaultHeader(“Accept-Encoding", "gzip");

BASIC AUTHENTICATION
Authenticating the request with basic authentication can be done by
calling the basicAuth(username, password) function:
.

CUSTOMIZABLE TIMEOUT, LEVELS
AND PROXY SETTINGS
1. Customizable timeout
You can set custom connection and socket timeout values (in milliseconds):
By default the connection timeout (the time it takes to connect to a server) is 10000, and the socket timeout (the time it takes to
receive data) is 60000. You can set any of these timeouts to zero to disable the timeout.
Configure connection and socket timeouts :
1
Unirest.setTimeouts(20000, 15000)
2. Customizable levels: Let’s set the number of connections and number maximum
connections per route:
.

CUSTOMIZABLE TIMEOUT, LEVELS
AND PROXY SETTINGS
Proxy settings:
You can set a proxy by invoking:
.

CUSTOMIZABLE DEFAULT HEADERS
Default Request Headers
You can set default headers that will be sent on every request:
Unirest.setDefaultHeader("Accept-Language", "en-GB,en-US;q=0.9,en;q=0.81");
Clear Default Header:
You can clear the default headers anytime with:
Unirest.clearDefaultHeaders();
.

Customizable HttpClient and HttpAsyncClient implementation
You can explicitly set your
own HttpClient and HttpAsyncClient implementations by using
the following methods:
Unirest.setHttpClient(httpClient);
Unirest.setAsyncHttpClient(asyncHttpClient);

AUTOMATIC JSON PARSING INTO A NATIVE
OBJECT FOR JSON RESPONSES
➤ Unirest uses Jackson lib to parse JSON responses into java
object.
HttpResponse<JsonNode> jsonResponse = Unirest.post("http://httpbin.org/post")
.field("parameter", "value")
.field("file", new File("/tmp/file"))
.asJson();
.

CUSTOMIZABLE BINDING, WITH MAPPING FROM
RESPONSE BODY TO JAVA OBJECT
Before an asObject(Class) or a .body(Object) invokation, is necessary to provide a custom implementation of
the ObjectMapper interface. This should be done only the first time, as the instance of the ObjectMapper will be shared
globally.
For example, serializing Json fromto Object using the popular Jackson ObjectMapper takes only few lines of code.
.
// Only one time
Unirest.setObjectMapper(new ObjectMapper() {
private com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper
= new com.fasterxml.jackson.databind.ObjectMapper();
public <T> T readValue(String value, Class<T> valueType) {
try {
return jacksonObjectMapper.readValue(value, valueType);
} catch (IOException e) {
throw new RuntimeException(e);
}
}

CUSTOMIZABLE BINDING, WITH MAPPING FROM
RESPONSE BODY TO JAVA OBJECT
// Response to Object
HttpResponse<Book> bookResponse = Unirest.get("http://httpbin.org/books/1").asObject(Book.class);
Book bookObject = bookResponse.getBody();
HttpResponse<Author> authorResponse = Unirest.get("http://httpbin.org/books/{id}/author")
.routeParam("id", bookObject.getId())
.asObject(Author.class);
Author authorObject = authorResponse.getBody();
// Object to Json
HttpResponse<JsonNode> postResponse = Unirest.post("http://httpbin.org/authors/post")
.header("Content-Type", "application/json")
.

Demo Project: Java REST Client Using Unirest Java API
➤ Check this link: https://interviewbubble.com/demo-project-java-
rest-client-using-unirest-java-api/

Unirest Java Tutorial | Java Http Client

Recommended

More Related Content

What's hot (20)

Similar to Unirest Java Tutorial | Java Http Client (20)

Recently uploaded (20)

Unirest Java Tutorial | Java Http Client