Table of Contents
In this tutorial, we will see how to create rest client using Spring RestTemplate.
We have already seen Spring restful web services crud example. We have used postman utility to demonstrate all HTTP methods such as get, post, delete and put but if you want to write java code for restful client , you can use Spring RestTemplate.
You can always use java ‘s HttpClient but Spring RestTemplate provides more methods and options that you can use to consume Spring restful web services via Http methods.
Here is list of methods provided by Spring Resttemplate for each http methods.
|
Method
|
Spring RestTemplate’s method
|
|
Get
|
 getForObject, getForEntity
|
|
Post
|
postForObject(String url, Object request, Class responseType, String…​ uriVariables)
postForLocation(String url, Object request, String…​ urlVariables), |
|
Put
|
put(String url, Object request, String…​urlVariables)
|
|
Delete
|
delete()
|
|
Head
|
headForHeaders(String url, String…​ urlVariables)
|
|
Options
|
optionsForAllow(String url, String…​ urlVariables)
|
I am using same example which we have seen in Spring rest crud example. I am using java client instead of postman to consure Rest APIs.
Get example:
You can use getForObject or getForEntity for calling http get method.
Spring Rest API Code get method:
|
1 2 3 4 5 6 |
@RequestMapping(value = "/country/{id}", method = RequestMethod.GET, headers = "Accept=application/json") public Country getCountryById(@PathVariable int id) { return countryService.getCountry(id); } |
Spring RestTemplate get Method :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
package org.arpit.java2blog.client; import org.arpit.java2blog.bean.Country; import org.springframework.web.client.RestTemplate; /** * @author Arpit Mandliya */ public class SpringRestTemplateExample { public static void main(String args[]) { RestTemplate restTemplate = new RestTemplate(); Country bhutan = restTemplate .getForObject("http://localhost:8080/SpringRestfulWebServicesCRUDExample/country/{id}", Country.class,2); System.out.println("Country Name:"+bhutan.getCountryName()); System.out.println("Population:"+bhutan.getPopulation()); } } |
|
1 2 3 4 |
Country Name:Bhutan Population:7000 |
Post example :
You can use PostForObject or PostForLocation to call post method.
Spring Rest API Code post method:
|
1 2 3 4 5 6 |
@RequestMapping(value = "/countries", method = RequestMethod.POST, headers = "Accept=application/json") public Country addCountry(@RequestBody Country country) { return countryService.addCountry(country); } |
Spring RestTemplate post Method :
|
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 |
package org.arpit.java2blog.client; import org.arpit.java2blog.bean.Country; import org.springframework.web.client.RestTemplate; /** * @author Arpit Mandliya */ public class SpringRestTemplateExample { public static void main(String args[]) { RestTemplate restTemplate = new RestTemplate(); final String uri = "http://localhost:8080/SpringRestfulWebServicesCRUDExample/countries"; Country country = new Country(); country.setCountryName("USA"); country.setPopulation(4000); Country addedCountry = restTemplate.postForObject( uri, country, Country.class); System.out.println("Country added : " +addedCountry.getCountryName()); } } |
|
1 2 3 |
Country added : USA |
Put example :
You can use put to call http put method.
Spring Rest API Code put method:
|
1 2 3 4 5 6 |
@RequestMapping(value = "/countries", method = RequestMethod.PUT, headers = "Accept=application/json") public Country updateCountry(@RequestBody Country country) { return countryService.updateCountry(country); } |
Spring RestTemplate put Method :
|
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 |
package org.arpit.java2blog.client; import java.util.HashMap; import java.util.Map; import org.arpit.java2blog.bean.Country; import org.springframework.web.client.RestTemplate; /** * @author Arpit Mandliya */ public class SpringRestTemplateExample { public static void main(String args[]) { final String uriForPut = "http://localhost:8080/SpringRestfulWebServicesCRUDExample/countries"; Country country = new Country(); country.setId(2); country.setCountryName("Bhutan"); country.setPopulation(10000); RestTemplate restTemplate = new RestTemplate(); restTemplate.put ( uriForPut, country); } } |
Delete example :
You can use delete to call http delete method.
Spring Rest API Code delete method:
|
1 2 3 4 5 6 7 |
@RequestMapping(value = "/country/{id}", method = RequestMethod.DELETE, headers = "Accept=application/json") public void deleteCountry(@PathVariable("id") int id) { countryService.deleteCountry(id); } |
Spring RestTemplate delete Method :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
package org.arpit.java2blog.client; import java.util.HashMap; import java.util.Map; import org.springframework.web.client.RestTemplate; /** * @author Arpit Mandliya */ public class SpringRestTemplateExample { public static void main(String args[]) { final String uriForDelete = "http://localhost:8080/SpringRestfulWebServicesCRUDExample/country/{id}"; Map<String, String> params = new HashMap<String, String>(); params.put("id","2"); RestTemplate restTemplate = new RestTemplate(); restTemplate.delete ( uriForDelete,params); } } |
You may also like:
- Create RESTful web service in java(JAX-RS) using jersey
- RESTful web service JAXRS json example using jersey
- RESTful web service JAXRS CRUD example using jersey
- JAX-WS web service eclipse tutorial
- JAX-WS web service deployment on tomcat
- AngularJS RESTful web service
- Spring Rest simple example
- Spring Rest json example
- Spring Rest xml example
- Spring Rest CRUD example
Was this post helpful?
Let us know if this post was helpful. Feedbacks are monitored on daily basis. Please do provide feedback as that\'s the only way to improve.
