So far, we have covered sending a GET & POST Request in our tutorial on Apache HttpClient. If you haven’t checked that, lets check ‘Sending GET Request’ by clicking this link and also check ‘Sending POST request’ using this link. Now, in this example, we are going to see “How to send a PUT request with JSON as request body using Apache HttpClient by utilizing HttpPut method?”.
In this tutorial, we are going to cover below topics:
- What is HTTP PUT Request?
- How to send PUT request with JSON using Apache HttpClient?
Check out: PUT REQUEST using another popular API testing Framework – REST ASSURED
Let’s begin:
1. What is HTTP PUT Request?
PUT method requests for the enclosed entity are stored under the Request-URI. An update operation will happen if the Request-URI refers to already existing resource otherwise there will be a create operation takes place if Request-URI is a valid resource URI.
Some key points of PUT requests:
- PUT is idempotent means if you try to make a request multiple times, it would result in the same output as it would have no effect.
- PUT should be used when you want to modify a resource which is already a part of resource collection as PUT method would replace the resource entirely.
- PUT resource can be cached.
2. How to send PUT request with JSON using Apache HttpClient?
In this tutorial, we will test the ‘Dummy Sample Rest API’ which is available here. This page contains Fake Online REST API for the testing purposes which are performing various CRUD operations.
Let’s take an example of one of the API PUT endpoint available at the above-mentioned website which is ‘/update/{id}’. The full-service URL with endpoint is ‘http://dummy.restapiexample.com/api/v1/update/{id}’.
At the above resource URL, we are going to submit data in the form of JSON to update an existing employee which is having ‘id’ as ‘4710’.
NOTE: This ‘id’ belongs to the employee which is generated during the POST call to create the employee. So, this id : 4710 generated for me when I had executed the create employee using the POST call. In order to get yours, first execute the POST Request call available at this link and grab the ‘id‘ from the response and use it in your PUT Request Test below in place where I am using ‘4710’.
JSON Request Body:
1 2 3 4 5 | { "name":"put_test_employee", "salary":"1123", "age":"23" } |
Here is the code to send the PUT request (containing request body in JSON format) to the above mentioned REST API Service Endpoint:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import org.apache.http.HttpResponse; import org.apache.http.client.ClientProtocolException; import org.apache.http.client.methods.HttpPut; import org.apache.http.entity.StringEntity; import org.apache.http.impl.client.CloseableHttpClient; import org.apache.http.impl.client.HttpClients; import org.testng.annotations.Test; /** * This class shows how to send a PUT Request with JSON using 'HttpPut' method of Apache HttpClient library. * @author Deepak Verma **/ public class Put_Request_Apache_HttpClient { @Test public void updateEmployee() throws ClientProtocolException, IOException { String putEndpoint = "http://dummy.restapiexample.com/api/v1/update/4710"; CloseableHttpClient httpclient = HttpClients.createDefault(); HttpPut httpPut = new HttpPut(putEndpoint); httpPut.setHeader("Accept", "application/json"); httpPut.setHeader("Content-type", "application/json"); String inputJson = "{\n" + " \"name\": \"put_test_employee\",\n" + " \"salary\": \"1123\",\n" + " \"age\": \"23\"\n" + "}"; StringEntity stringEntity = new StringEntity(inputJson); httpPut.setEntity(stringEntity); System.out.println("Executing request " + httpPut.getRequestLine()); HttpResponse response = httpclient.execute(httpPut); BufferedReader br = new BufferedReader(new InputStreamReader((response.getEntity().getContent()))); //Throw runtime exception if status code isn't 200 if (response.getStatusLine().getStatusCode() != 200) { throw new RuntimeException("Failed : HTTP error code : " + response.getStatusLine().getStatusCode()); } //Create the StringBuffer object and store the response into it. StringBuffer result = new StringBuffer(); String line = ""; while ((line = br.readLine()) != null) { System.out.println("Response : \n" + result.append(line)); } //Lets validate if a text 'employee_salary' is present in the response System.out.println("Does Reponse contains 'salary'? :" + result.toString().contains("salary")); } } |
Let’s try to understand the code:
1. Specify the URL and set up CloseableHttpClient object
1 2 3 | String putEndpoint = "http://dummy.restapiexample.com/api/v1/update/4710"; CloseableHttpClient httpclient = HttpClients.createDefault(); |
2. Create a basic Put Request and pass the resource URI to it and also assign headers to this put object
1 2 3 4 5 | HttpPut httpPut = new HttpPut(putEndpoint); httpPut.setHeader("Accept", "application/json"); httpPut.setHeader("Content-type", "application/json"); |
3. Supply the json request into the StringEntity object and assign it to the put object.
1 2 3 | StringEntity stringEntity = new StringEntity(inputJson); httpPut.setEntity(stringEntity); |
4. Submit the Request using HttpPut -> Execute method
1 | HttpResponse response = httpclient.execute(httpPut); |
5. Create a BufferedReader object and store the raw Response content into it.
1 | BufferedReader br = new BufferedReader( new InputStreamReader((response.<wbr />getEntity().getContent()))); |
6. Throw runtime exception if status code isn’t 200
1 2 3 | if (response.getStatusLine().<wbr />getStatusCode() != 200) { throw new RuntimeException("Failed : HTTP error code : " + response.getStatusLine().<wbr />getStatusCode()); } |
7. Create the StringBuffer object and store the response into it.
1 2 3 4 5 6 7 | StringBuffer result = new StringBuffer(); String line = ""; while ((line = br.readLine()) != null) { System.out.println("Response : \n"+result.append(line)); } |
8. Finally, Lets validate if a text ’employee_salary’ is present in the response
1 | result.toString().contains("<wbr />employee_salary") |
Eclipse Console Output:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | [RemoteTestNG] detected TestNG version 6.14.3 Executing request PUT http://dummy.restapiexample.com/api/v1/update/4710 HTTP/1.1 Response : {"name":"put_test_employee","salary":"1123","age":"23"} Does Reponse contains 'salary'? :true PASSED: createEmployee =============================================== Default test Tests run: 1, Failures: 0, Skips: 0 =============================================== =============================================== Default suite Total tests run: 1, Failures: 0, Skips: 0 =============================================== |
That’s it, it’s that simple to make a PUT Request with JSON body using Apache HttpClient: ?
Simple example of PUT Request with JSON using Apache HttpClient...!!! Click To TweetIf you like this post , please check out my other useful blog posts
Other Useful References:
