From 2ed008decce1d050044cd79f5f5c3d077c147981 Mon Sep 17 00:00:00 2001
From: mdabrowski-eu <57441874+mdabrowski-eu@users.noreply.github.com>
Date: Mon, 2 Oct 2023 13:53:53 +0200
Subject: [PATCH] BAEL-6911 A Guide to RestClient in Spring Boot (#14893)
---
spring-boot-modules/spring-boot-3/pom.xml | 61 +++++++++-
.../java/com/baeldung/restclient/Article.java | 34 ++++++
.../restclient/ArticleController.java | 45 +++++++
.../restclient/RestClientApplication.java | 13 ++
.../restclient/RestClientIntegrationTest.java | 114 ++++++++++++++++++
5 files changed, 266 insertions(+), 1 deletion(-)
create mode 100644 spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/Article.java
create mode 100644 spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/ArticleController.java
create mode 100644 spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/RestClientApplication.java
create mode 100644 spring-boot-modules/spring-boot-3/src/test/java/com/baeldung/restclient/RestClientIntegrationTest.java
diff --git a/spring-boot-modules/spring-boot-3/pom.xml b/spring-boot-modules/spring-boot-3/pom.xml
index 7e61ca18af..7dd44c89dc 100644
--- a/spring-boot-modules/spring-boot-3/pom.xml
+++ b/spring-boot-modules/spring-boot-3/pom.xml
@@ -41,6 +41,27 @@
mockserver-netty
${mockserver.version}
+
+ org.junit.jupiter
+ junit-jupiter
+ ${jupiter.version}
+
+
+ org.junit.jupiter
+ junit-jupiter-api
+ ${jupiter.version}
+
+
+ org.junit.jupiter
+ junit-jupiter-engine
+ ${jupiter.version}
+
+
+ org.junit.jupiter
+ junit-jupiter-params
+ ${jupiter.version}
+ test
+
org.mock-server
mockserver-client-java
@@ -187,8 +208,46 @@
3.0.0-M7
com.baeldung.sample.TodoApplication
5.14.0
- 3.1.0
+ 3.2.0-SNAPSHOT
0.2.0
+ 5.10.0
+
+
+ spring-milestones
+ Spring Milestones
+ https://repo.spring.io/milestone
+
+ false
+
+
+
+ spring-snapshots
+ Spring Snapshots
+ https://repo.spring.io/snapshot
+
+ false
+
+
+
+
+
+ spring-milestones
+ Spring Milestones
+ https://repo.spring.io/milestone
+
+ false
+
+
+
+ spring-snapshots
+ Spring Snapshots
+ https://repo.spring.io/snapshot
+
+ false
+
+
+
+
\ No newline at end of file
diff --git a/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/Article.java b/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/Article.java
new file mode 100644
index 0000000000..a69d5989af
--- /dev/null
+++ b/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/Article.java
@@ -0,0 +1,34 @@
+package com.baeldung.restclient;
+
+import java.util.Objects;
+
+public class Article {
+ Integer id;
+ String title;
+
+ public Article(Integer id, String title) {
+ this.id = id;
+ this.title = title;
+ }
+
+ public Integer getId() {
+ return id;
+ }
+
+ public String getTitle() {
+ return title;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ Article article = (Article) o;
+ return Objects.equals(id, article.id) && Objects.equals(title, article.title);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(id, title);
+ }
+}
diff --git a/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/ArticleController.java b/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/ArticleController.java
new file mode 100644
index 0000000000..62922bdcee
--- /dev/null
+++ b/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/ArticleController.java
@@ -0,0 +1,45 @@
+package com.baeldung.restclient;
+
+import org.springframework.web.bind.annotation.*;
+
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+
+@RestController
+@RequestMapping("/articles")
+public class ArticleController {
+ Map database = new HashMap<>();
+
+ @GetMapping
+ public Collection getArticles() {
+ return database.values();
+ }
+
+ @GetMapping("/{id}")
+ public Article getArticle(@PathVariable Integer id) {
+ return database.get(id);
+ }
+
+ @PostMapping
+ public void createArticle(@RequestBody Article article) {
+ database.put(article.getId(), article);
+ }
+
+ @PutMapping("/{id}")
+ public void updateArticle(@PathVariable Integer id, @RequestBody Article article) {
+ assert Objects.equals(id, article.getId());
+ database.remove(id);
+ database.put(id, article);
+ }
+
+ @DeleteMapping("/{id}")
+ public void deleteArticle(@PathVariable Integer id) {
+ database.remove(id);
+ }
+ @DeleteMapping()
+ public void deleteArticles() {
+ database.clear();
+ }
+}
diff --git a/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/RestClientApplication.java b/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/RestClientApplication.java
new file mode 100644
index 0000000000..c411a8f74a
--- /dev/null
+++ b/spring-boot-modules/spring-boot-3/src/main/java/com/baeldung/restclient/RestClientApplication.java
@@ -0,0 +1,13 @@
+package com.baeldung.restclient;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class RestClientApplication {
+
+ public static void main(String[] args) {
+ SpringApplication.run(RestClientApplication.class, args);
+ }
+
+}
diff --git a/spring-boot-modules/spring-boot-3/src/test/java/com/baeldung/restclient/RestClientIntegrationTest.java b/spring-boot-modules/spring-boot-3/src/test/java/com/baeldung/restclient/RestClientIntegrationTest.java
new file mode 100644
index 0000000000..92474c88f0
--- /dev/null
+++ b/spring-boot-modules/spring-boot-3/src/test/java/com/baeldung/restclient/RestClientIntegrationTest.java
@@ -0,0 +1,114 @@
+package com.baeldung.restclient;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.core.ParameterizedTypeReference;
+import org.springframework.http.MediaType;
+import org.springframework.web.client.RestClient;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+public class RestClientIntegrationTest {
+
+ @LocalServerPort
+ private int port;
+ private String uriBase;
+ RestClient restClient = RestClient.create();
+
+ @BeforeAll
+ public void setup() {
+ uriBase = "http://localhost:" + port;
+ }
+
+ @AfterEach
+ public void teardown() {
+ restClient.delete()
+ .uri(uriBase + "/articles")
+ .retrieve()
+ .toBodilessEntity();
+ }
+
+ @Test
+ void shouldGetArticlesAndReturnString() {
+ String articlesAsString = restClient.get()
+ .uri(uriBase + "/articles")
+ .retrieve()
+ .body(String.class);
+
+ assertThat(articlesAsString).isEqualTo("[]");
+ }
+
+ @Test
+ void shouldPostAndGetArticles() {
+ Article article = new Article(1, "How to use RestClient");
+ restClient.post()
+ .uri(uriBase + "/articles")
+ .contentType(MediaType.APPLICATION_JSON)
+ .body(article)
+ .retrieve()
+ .toBodilessEntity();
+
+ List articles = restClient.get()
+ .uri(uriBase + "/articles")
+ .retrieve()
+ .body(new ParameterizedTypeReference<>() {});
+
+ assertThat(articles).isEqualTo(List.of(article));
+ }
+
+ @Test
+ void shouldPostAndPutAndGetArticles() {
+ Article article = new Article(1, "How to use RestClient");
+ restClient.post()
+ .uri(uriBase + "/articles")
+ .contentType(MediaType.APPLICATION_JSON)
+ .body(article)
+ .retrieve()
+ .toBodilessEntity();
+
+ Article articleChanged = new Article(1, "How to use RestClient even better");
+ restClient.put()
+ .uri(uriBase + "/articles/1")
+ .contentType(MediaType.APPLICATION_JSON)
+ .body(articleChanged)
+ .retrieve()
+ .toBodilessEntity();
+
+ List articles = restClient.get()
+ .uri(uriBase + "/articles")
+ .retrieve()
+ .body(new ParameterizedTypeReference<>() {});
+
+ assertThat(articles).isEqualTo(List.of(articleChanged));
+ }
+
+ @Test
+ void shouldPostAndDeleteArticles() {
+ Article article = new Article(1, "How to use RestClient");
+ restClient.post()
+ .uri(uriBase + "/articles")
+ .contentType(MediaType.APPLICATION_JSON)
+ .body(article)
+ .retrieve()
+ .toBodilessEntity();
+
+ restClient.delete()
+ .uri(uriBase + "/articles")
+ .retrieve()
+ .toBodilessEntity();
+
+ List articles = restClient.get()
+ .uri(uriBase + "/articles")
+ .retrieve()
+ .body(new ParameterizedTypeReference<>() {});
+
+ assertThat(articles).isEqualTo(List.of());
+ }
+}