Spring REST client using RestTemplate in Eclipse and Maven

In this article, I will be demonstrating how you can create a Spring REST client using RestTemplate. In order to see how you can create a simple Spring REST service, you can refer to this blog post.

What is Spring RESTTemplate?

Spring provides a class called RestTemplate. This is the starting point in creating a REST client application.  It uses the URI and the HTTP method to invoke in order to connect to a REST service. It has several methods that allow you to invoke the HTTP methods on the specified URI

Edit

Project Creation

Step 1 – Create a Maven Project in Eclipse. You can refer to this blog post. You will get a project as follows:

 

Step 2 – Add dependencies to POM file.

Add the following to your pom.xml file:

<properties>    <spring.framework>5.1.3.RELEASE</spring.framework>    <spring.web>5.1.3.RELEASE</spring.web>  </properties>  <dependencies>    <dependency>      <groupId>org.springframework</groupId>      <artifactId>spring-core</artifactId>      <version>${spring.framework}</version>    </dependency>    <dependency>      <groupId>org.springframework</groupId>      <artifactId>spring-context</artifactId>      <version>${spring.framework}</version>    </dependency>    <dependency>      <groupId>org.codehaus.jackson</groupId>      <artifactId>jackson-mapper-asl</artifactId>      <version>1.9.4</version>    </dependency>    <dependency>      <groupId>org.springframework</groupId>      <artifactId>spring-web</artifactId>      <version>${spring.web}</version>    </dependency>  </dependencies>

Code

Server code

Before we write the client code, we need to have a REST service which the client will invoke. Refer to this blog post in order to see how to create a simple REST service. Assume that we have a REST service as follows:

@RestControllerpublic class HelloWorldController {  @RequestMapping("/hello")  public String helloWorld() {     System.out.println("In HelloWorldController");    String message = "Hello World";    return message;  }}

 

Writing Code

Step 3 – Create a Java class as follows:

public class DemoClient {    final static String ROOT_URI = "http://localhost:8080/SpringRestDemo/hello";  public static void main(String[] args) {    RestTemplate restTemplate = new RestTemplate();    ResponseEntity<String> response = restTemplate.getForEntity(ROOT_URI, String.class);    System.out.println("Response is "+response.getBody());  }}

Code Explanation

This code uses the RestTemplate class. It uses the getForEntitymethod.The restTemplate.getForEntity method accepts the server URI and a class instance of the data type that the server method returns. In this case, I’m using a String.class   since the service that is being invoked returns String data. It returns a ResponseEntityof the data type that the server application returns. We can then use the responseEntity.getBodymethod to retrieve the actual response body from the ResponseEntity.

Just like the getForEntity, there are other methods available on the RestTemplate which you can use to execute the other HTTP methods like postForEntity, put, etc.

Testing

Step 4 – Ensure the Rest service is running at the http://localhost:8080/SpringRestDemo/hello URI.

Step 5 – Run the code. The following output should be seen on the console.

Response is Hello World

Further Learning

Spring MasterClass
Spring Tutorial For Beginners
Step by Step Spring MVC Tutorial
Spring Framework in Easy Steps

Conclusion

In this article, you saw how to create a Spring REST client using Eclipse and Maven. You saw how the Spring RESTTemplate example can be used to execute a GET Request.

You can download the complete source code from the Github repository here.

Comments

Post a Comment

Popular posts from this blog

How to use logging in SpringBoot with code samples

Image
In this article, we will learn how to use logging in SpringBoot. Introduction There are several Java logging frameworks like logback, log4j, and so on. Spring Boot supports out-of-the-box support for logback. Let us learn how to use logging in SpringBoot with logback. Step 1 – Create a New Maven Project Create a new Maven project. (Refer to  this  blog post). This will create a project in Eclipse as follows:   Step 2 – Add the Spring Boot Dependencies Add the spring-boot-starter-web dependency to the pom.xml . So, the pom.xml should look as follows: <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.learnjava</groupId> <artifactId>learnjava-springboot-logging-example</artifactId> <version>0.0.1-SNAPSHOT&
Read more

Python While Loop with code samples

Much like a Java while loop, you can use a Python while loop to repeatedly execute a block of code as long as a condition is true. In this article, we will learn more about the Python while loop. Python While loop Syntax A while loop in Python has the following syntax: while <condition>: loop body The while keyword is followed by a condition. If the condition evaluates to true, the body of the loop is executed. Once the body of the loop is completed, the condition is checked again and this is repeated until the condition evaluates to false at which point the loop is exited. While loop Sample Code The following code demonstrates how you can use the while loop: num=10counter=1total=0while counter<=num: total += counter counter+=1print("sum of first 10 numbers is",total) This code adds the numbers from 1 to 10 and prints the sum. It uses a while loop to iterate from 1 to 10. The while loop checks the condition counter <= num and if so adds the current value of count
Read more

How to convert a List to a Set

In this blog post ,I will be showing you how you can convert a List to a Set. Consider the following code snippet: public class ListToSetDemo {public static void main(String[] args) {List<Integer> list = Arrays.asList(5,3,11,15,9);//Method 1Set<Integer> set = new HashSet<Integer>(list);System.out.println("Set is "+set);//method 2Set<Integer> set2 = new HashSet<Integer>();set2.addAll(list);System.out.println("Set is "+set2);}} This code demonstrates two ways to convert a List to a Set. Method 1 Here, we are creating a new HashSet . We are invoking the constructor that accepts a Collection object. Here, we are passing in the input list to this constructor.   Method 2 Here again, we are creating a new HashSet . However, we are using the default constructor. We are then invoking the addAll method and passing in the input list.   When you run this code, it will print the following output: Set is [3, 5, 9, 11, 15]Set is [3, 5, 9, 11, 15] No
Read more