How do you write unit tests for REST API controllers in Spring Boot?

Table of Contents

• Introduction
• Steps to Write Unit Tests for REST API Controllers
  • 1. Set Up Testing Dependencies
  • 2. Create the REST Controller
  • 3. Set Up the Unit Test Class
  • 4. Mocking Dependencies with **@MockBean**
  • 5. Performing HTTP Requests Using **MockMvc**
  • 6. Test Different HTTP Methods
  • 7. Handling Assertions
• Conclusion

Introduction

Writing unit tests for REST API controllers in Spring Boot is crucial for ensuring that your API behaves as expected. Unit tests for controllers focus on verifying that the endpoints respond correctly to different HTTP requests. This can be done efficiently using tools like MockMvc, which allows you to simulate HTTP requests and assert the responses without needing to spin up the entire application.

Steps to Write Unit Tests for REST API Controllers

1. Set Up Testing Dependencies

First, ensure that your pom.xml or build.gradle file includes the necessary dependencies for testing:

• spring-boot-starter-test – for basic testing utilities.
• mockmvc – to simulate HTTP requests and test the responses.

Example for pom.xml:

2. Create the REST Controller

Here is an example REST controller for user management:

3. Set Up the Unit Test Class

In your test class, use the @WebMvcTest annotation to test only the controller layer and isolate it from other parts of the application like the service or repository layer.

Example test class:

4. Mocking Dependencies with **@MockBean**

To isolate the controller layer from other layers (like the service or repository), use the @MockBean annotation to mock the UserService. This allows you to mock the behavior of methods like findById() or createUser() without needing a real database or service implementation.

5. Performing HTTP Requests Using **MockMvc**

MockMvc is used to simulate HTTP requests (GET, POST, etc.) and test the responses. It is injected into the test class using @Autowired and allows you to perform requests and assert different conditions on the response, such as the status code and body content.

Example of performing a GET request:

6. Test Different HTTP Methods

Unit tests should cover all possible HTTP methods your controller supports (GET, POST, PUT, DELETE). Here's an example of testing a POST method:

7. Handling Assertions

You can use the andExpect() method from MockMvcResultMatchers to assert the response. Some common assertions include:

• status().isOk() – Check if the status is 200 OK.
• status().isCreated() – Check if the status is 201 Created.
• jsonPath() – Check specific values in the JSON response.

Conclusion

Writing unit tests for REST API controllers in Spring Boot is essential for validating that your API behaves as expected. By using annotations like @WebMvcTest and tools like MockMvc, you can simulate HTTP requests and assert the responses effectively. Mocking dependencies like services ensures that your tests remain isolated and focused on the controller layer, making them efficient and easy to maintain.