TestRestTemplate for API testing in JUnit

Introduction

TestRestTemplate helps you test APIs by sending real HTTP requests and checking responses easily.

When you want to check if your REST API returns the right data.

When you need to test API endpoints during development.

When you want to verify HTTP status codes and response bodies.

When you want to simulate client requests to your server in tests.

Syntax

JUnit

TestRestTemplate restTemplate = new TestRestTemplate();
ResponseEntity<String> response = restTemplate.getForEntity("http://localhost:8080/api/example", String.class);

Use getForEntity to send a GET request and get full response details.

TestRestTemplate is easy to use for integration tests in Spring Boot.

Examples

Simple GET request test checking status and response body.

JUnit

TestRestTemplate restTemplate = new TestRestTemplate();
ResponseEntity<String> response = restTemplate.getForEntity("http://localhost:8080/api/hello", String.class);
assertEquals(HttpStatus.OK, response.getStatusCode());
assertEquals("Hello World", response.getBody());

POST request test sending JSON data and checking creation status.

JUnit

TestRestTemplate restTemplate = new TestRestTemplate();
Map<String, String> request = Map.of("name", "Alice");
ResponseEntity<String> response = restTemplate.postForEntity("http://localhost:8080/api/greet", request, String.class);
assertEquals(HttpStatus.CREATED, response.getStatusCode());

Sample Program

This test sends a GET request to /api/hello and checks if the response is 200 OK with body "Hello World".

JUnit

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpStatus;
import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class ApiTest {

    private final TestRestTemplate restTemplate = new TestRestTemplate();

    @Test
    public void testGetHello() {
        ResponseEntity<String> response = restTemplate.getForEntity("http://localhost:8080/api/hello", String.class);
        assertEquals(HttpStatus.OK, response.getStatusCode());
        assertEquals("Hello World", response.getBody());
    }
}

Important Notes

Make sure your API server is running on the expected port before running tests.

Use SpringBootTest.WebEnvironment.DEFINED_PORT to test with a real server port.

TestRestTemplate is good for integration tests, not unit tests.

Summary

TestRestTemplate sends real HTTP requests to test APIs.

It helps check status codes and response content easily.

Use it in integration tests to simulate client calls.

Practice

1. What is the primary purpose of TestRestTemplate in JUnit testing?

easy

A. To mock database connections during tests

B. To send real HTTP requests to test REST APIs

C. To generate random test data for unit tests

D. To create UI components for testing

Solution

1. Step 1: Understand the role of TestRestTemplate

   TestRestTemplate is designed to send actual HTTP requests to REST APIs during integration tests.

2. Step 2: Compare with other options

   Mocking databases, generating test data, or creating UI components are unrelated to TestRestTemplate's purpose.

3. Final Answer:

   To send real HTTP requests to test REST APIs -> Option B

4. Quick Check:

   TestRestTemplate = Real HTTP requests [OK]

Hint: Remember: TestRestTemplate sends real HTTP calls [OK]

Common Mistakes:

• Confusing TestRestTemplate with mocking tools
• Thinking it generates test data
• Assuming it tests UI components

2. Which of the following is the correct way to autowire TestRestTemplate in a Spring Boot test class?

easy

A. @Autowired private TestRestTemplate restTemplate;

B. private TestRestTemplate restTemplate = new TestRestTemplate();

C. @InjectMocks private TestRestTemplate restTemplate;

D. private TestRestTemplate restTemplate = null;

Solution

1. Step 1: Identify correct Spring Boot injection

   In Spring Boot tests, @Autowired is used to inject TestRestTemplate automatically.

2. Step 2: Evaluate other options

   Creating a new instance manually or using @InjectMocks is incorrect for TestRestTemplate injection in Spring Boot tests.

3. Final Answer:

   @Autowired private TestRestTemplate restTemplate; -> Option A

4. Quick Check:

   Use @Autowired for TestRestTemplate injection [OK]

Hint: Use @Autowired to inject TestRestTemplate [OK]

Common Mistakes:

• Manually instantiating TestRestTemplate
• Using @InjectMocks instead of @Autowired
• Leaving the variable null without injection

3. Given the following test code snippet using TestRestTemplate:

ResponseEntity<String> response = restTemplate.getForEntity("/api/users/1", String.class);
int statusCode = response.getStatusCodeValue();
String body = response.getBody();

If the API returns HTTP 200 with body "User Found", what will be the values of statusCode and body?

medium

A. statusCode = 404, body = null

B. statusCode = 500, body = "Error"

C. statusCode = 200, body = "User Found"

D. statusCode = 200, body = null

Solution

1. Step 1: Understand getForEntity behavior

   getForEntity sends a GET request and returns the full response including status and body.

2. Step 2: Match API response to variables

   Since API returns 200 and "User Found", statusCode will be 200 and body will be "User Found".

3. Final Answer:

   statusCode = 200, body = "User Found" -> Option C

4. Quick Check:

   API 200 + body = statusCode 200 & body "User Found" [OK]

Hint: getForEntity returns status and body as received [OK]

Common Mistakes:

• Assuming body is null on success
• Confusing status codes with error codes
• Ignoring response body content

4. Consider this test code using TestRestTemplate:

@Autowired
private TestRestTemplate restTemplate;

@Test
public void testGetUser() {
    ResponseEntity<String> response = restTemplate.getForEntity("/api/users/", String.class);
    assertEquals(200, response.getStatusCodeValue());
}

What is the likely problem with this test?

medium

A. The URL is missing a user ID, causing a 404 error

B. The assertion should check for 404 instead of 200

C. TestRestTemplate cannot be autowired

D. ResponseEntity<String> is not a valid return type

Solution

1. Step 1: Analyze the request URL

   The URL "/api/users/" lacks a specific user ID, so the endpoint may not exist or return a list, not a single user.

2. Step 2: Understand the assertion failure cause

   Expecting status 200 for a missing user ID endpoint may cause a 404 error, failing the test.

3. Final Answer:

   The URL is missing a user ID, causing a 404 error -> Option A

4. Quick Check:

   Missing ID in URL causes 404, not 200 [OK]

Hint: Check URL completeness before asserting status [OK]

Common Mistakes:

• Assuming URL without ID returns 200
• Wrong assertion status code
• Thinking autowiring is the issue

5. You want to test a POST API endpoint /api/users that creates a user and returns HTTP 201 with the created user JSON. Which TestRestTemplate method and assertion combination correctly tests this?

hard

A. Use delete with user ID, then assert status 204

B. Use getForEntity with user ID, then assert status 200

C. Use exchange with GET method, then assert status 404

D. Use postForEntity with user object, then assert status 201 and response body contains user data

Solution

1. Step 1: Identify correct HTTP method for creation

   POST is used to create resources, so postForEntity is appropriate for sending the user object.

2. Step 2: Validate expected response and assertions

   The API returns 201 Created with user JSON, so assert status 201 and check response body contains user data.

3. Final Answer:

   Use postForEntity with user object, then assert status 201 and response body contains user data -> Option D

4. Quick Check:

   POST + postForEntity + assert 201 + check body [OK]

Hint: POST creation uses postForEntity and assert 201 [OK]

Common Mistakes:

• Using GET instead of POST for creation
• Asserting wrong status codes
• Ignoring response body validation