Скачать или смотреть How to Consume the REST API of Another Spring Boot Project Locally for Testing

Learn the best practices for consuming a `REST API` of one Spring Boot project within another during JUnit testing, with a focus on multi-module Maven project configuration.
---
This video is based on the question https://stackoverflow.com/q/70872384/ asked by the user 'Mark' ( https://stackoverflow.com/u/298406/ ) and on the answer https://stackoverflow.com/a/71541777/ provided by the user 'Mark' ( https://stackoverflow.com/u/298406/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Consume the REST API of another Spring Boot project locally

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Testing REST API Calls Between Spring Boot Projects

In a microservice architecture, you often have multiple Spring Boot applications that interact with each other. When building complex systems, it's common to face the challenge of testing one microservice while it communicates with another. In this post, we will explore how to consume the REST API of another Spring Boot project locally during JUnit testing, without the need for creating mock APIs.

The Scenario

Imagine you have two Spring Boot applications:

project-api-1

project-api-2

While working on project-api-2, you find yourself needing to test functionality that relies on project-api-1. The question arises: How can you start the project-api-1 application during the tests of project-api-2? The goal is to avoid creating a mock API for project-api-1 within your project-api-2 tests, which could lead to unnecessary complexity.

The Solution

The solution is to create a multi-module Maven project. This approach allows you to incorporate the REST API of project-api-1 directly in your test environment for project-api-2, simplifying the testing process.

Step-by-Step Guide

Here’s how you can achieve it:

Set Up Multi-Module Maven Project:

Modify your Maven pom.xml to define project-api-1 as a module under your parent project. Use the <scope> tag to specify that it should only be included for test purposes.

[[See Video to Reveal this Text or Code Snippet]]

Running the Spring Boot Application:

In your JUnit tests for project-api-2, you can start the project-api-1 application programmatically. Use the SpringApplicationBuilder to boot the application with the appropriate profile for testing.

[[See Video to Reveal this Text or Code Snippet]]

Write Your Tests:

With project-api-1 up and running, you can now write the necessary tests in project-api-2 to test the functionality that interacts with the REST API. This setup will allow for realistic integration tests without the overhead of mock services.

Benefits

Realistic Testing: By running project-api-1, your tests in project-api-2 can interact with a real service, leading to more reliable results.

Reduced Complexity: You avoid the need to write and maintain mock APIs, which can be a source of errors and maintenance challenges.

Modular Structure: Utilizing a multi-module Maven project keeps your codebase organized and makes it easier to manage dependencies and versions across different projects.

Conclusion

Incorporating another Spring Boot application's REST API into your testing workflow can greatly enhance your microservices development experience. By utilizing a multi-module Maven structure and starting the necessary application within your tests, you can achieve a streamlined and efficient testing process. This approach not only simplifies your testing architecture but also provides more confidence in the functionalities being developed across your microservices.

By following the practices outlined above, you can effectively test interactions between different Spring Boot projects without the hassle of creating mock endpoints from scratch.