Merge pull request #6245 from rozagerardo/geroza/BAEL-11404_Update-and-move-Build-REST-API-article

[BAEL-11404] update and move 'Build Rest API' article code

spring-boot-rest/README.md

@@ -2,4 +2,5 @@ Module for the articles that are part of the Spring REST E-book:
 
 1. [Bootstrap a Web Application with Spring 5](https://www.baeldung.com/bootstraping-a-web-application-with-spring-and-java-based-configuration)
 2. [Error Handling for REST with Spring](http://www.baeldung.com/exception-handling-for-rest-with-spring)
-3. [REST Pagination in Spring](http://www.baeldung.com/rest-api-pagination-in-spring)
+3. [REST Pagination in Spring](http://www.baeldung.com/rest-api-pagination-in-spring)
+4. [Build a REST API with Spring and Java Config](http://www.baeldung.com/building-a-restful-web-service-with-spring-and-java-based-configuration)

spring-boot-rest/pom.xml

@@ -51,7 +51,6 @@
         <dependency>
             <groupId>net.sourceforge.htmlunit</groupId>
             <artifactId>htmlunit</artifactId>
-            <version>${htmlunit.version}</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -67,7 +66,6 @@
 
     <properties>
         <start-class>com.baeldung.SpringBootRestApplication</start-class>
-        <htmlunit.version>2.32</htmlunit.version>
         <guava.version>27.0.1-jre</guava.version>
     </properties>
 </project>

spring-boot-rest/src/main/java/com/baeldung/persistence/IOperations.java

@@ -1,16 +1,29 @@
 package com.baeldung.persistence;
 
 import java.io.Serializable;
+import java.util.List;
 
 import org.springframework.data.domain.Page;
 
 public interface IOperations<T extends Serializable> {
 
+    // read - one
+
+    T findOne(final long id);
+
     // read - all
 
+    List<T> findAll();
+
     Page<T> findPaginated(int page, int size);
 
     // write
 
     T create(final T entity);
+
+    T update(final T entity);
+
+    void delete(final T entity);
+
+    void deleteById(final long entityId);
 }

spring-boot-rest/src/main/java/com/baeldung/persistence/service/common/AbstractService.java

@@ -1,6 +1,7 @@
 package com.baeldung.persistence.service.common;
 
 import java.io.Serializable;
+import java.util.List;
 
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
@@ -8,23 +9,54 @@ import org.springframework.data.repository.PagingAndSortingRepository;
 import org.springframework.transaction.annotation.Transactional;
 
 import com.baeldung.persistence.IOperations;
+import com.google.common.collect.Lists;
 
 @Transactional
 public abstract class AbstractService<T extends Serializable> implements IOperations<T> {
 
+    // read - one
+
+    @Override
+    @Transactional(readOnly = true)
+    public T findOne(final long id) {
+        return getDao().findById(id)
+            .get();
+    }
+
     // read - all
 
+    @Override
+    @Transactional(readOnly = true)
+    public List<T> findAll() {
+        return Lists.newArrayList(getDao().findAll());
+    }
+
     @Override
     public Page<T> findPaginated(final int page, final int size) {
         return getDao().findAll(PageRequest.of(page, size));
     }
 
     // write
-
+    
     @Override
     public T create(final T entity) {
         return getDao().save(entity);
     }
+    
+    @Override
+    public T update(final T entity) {
+        return getDao().save(entity);
+    }
+
+    @Override
+    public void delete(final T entity) {
+        getDao().delete(entity);
+    }
+
+    @Override
+    public void deleteById(final long entityId) {
+        getDao().deleteById(entityId);
+    }
 
     protected abstract PagingAndSortingRepository<T, Long> getDao();
 

spring-boot-rest/src/main/java/com/baeldung/persistence/service/impl/FooService.java

@@ -1,5 +1,7 @@
 package com.baeldung.persistence.service.impl;
 
+import java.util.List;
+
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
@@ -11,6 +13,7 @@ import com.baeldung.persistence.dao.IFooDao;
 import com.baeldung.persistence.model.Foo;
 import com.baeldung.persistence.service.IFooService;
 import com.baeldung.persistence.service.common.AbstractService;
+import com.google.common.collect.Lists;
 
 @Service
 @Transactional
@@ -36,5 +39,13 @@ public class FooService extends AbstractService<Foo> implements IFooService {
     public Page<Foo> findPaginated(Pageable pageable) {
         return dao.findAll(pageable);
     }
+    
+    // overridden to be secured
+
+    @Override
+    @Transactional(readOnly = true)
+    public List<Foo> findAll() {
+        return Lists.newArrayList(getDao().findAll());
+    }
 
 }

spring-boot-rest/src/main/java/com/baeldung/web/controller/FooController.java

@@ -9,14 +9,16 @@ import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.http.HttpStatus;
-import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.util.UriComponentsBuilder;
 
 import com.baeldung.persistence.model.Foo;
@@ -24,9 +26,11 @@ import com.baeldung.persistence.service.IFooService;
 import com.baeldung.web.exception.MyResourceNotFoundException;
 import com.baeldung.web.hateoas.event.PaginatedResultsRetrievedEvent;
 import com.baeldung.web.hateoas.event.ResourceCreatedEvent;
+import com.baeldung.web.hateoas.event.SingleResourceRetrievedEvent;
+import com.baeldung.web.util.RestPreconditions;
 import com.google.common.base.Preconditions;
 
-@Controller
+@RestController
 @RequestMapping(value = "/auth/foos")
 public class FooController {
 
@@ -42,10 +46,24 @@ public class FooController {
 
     // API
 
+    // read - one
+
+    @GetMapping(value = "/{id}")
+    public Foo findById(@PathVariable("id") final Long id, final HttpServletResponse response) {
+        final Foo resourceById = RestPreconditions.checkFound(service.findOne(id));
+
+        eventPublisher.publishEvent(new SingleResourceRetrievedEvent(this, response));
+        return resourceById;
+    }
+
     // read - all
 
-    @RequestMapping(params = { "page", "size" }, method = RequestMethod.GET)
-    @ResponseBody
+    @GetMapping
+    public List<Foo> findAll() {
+        return service.findAll();
+    }
+
+    @GetMapping(params = { "page", "size" })
     public List<Foo> findPaginated(@RequestParam("page") final int page, @RequestParam("size") final int size,
         final UriComponentsBuilder uriBuilder, final HttpServletResponse response) {
         final Page<Foo> resultPage = service.findPaginated(page, size);
@@ -59,7 +77,6 @@ public class FooController {
     }
 
     @GetMapping("/pageable")
-    @ResponseBody
     public List<Foo> findPaginatedWithPageable(Pageable pageable, final UriComponentsBuilder uriBuilder,
         final HttpServletResponse response) {
         final Page<Foo> resultPage = service.findPaginated(pageable);
@@ -74,9 +91,8 @@ public class FooController {
 
     // write
 
-    @RequestMapping(method = RequestMethod.POST)
+    @PostMapping
     @ResponseStatus(HttpStatus.CREATED)
-    @ResponseBody
     public Foo create(@RequestBody final Foo resource, final HttpServletResponse response) {
         Preconditions.checkNotNull(resource);
         final Foo foo = service.create(resource);
@@ -86,4 +102,18 @@ public class FooController {
 
         return foo;
     }
+
+    @PutMapping(value = "/{id}")
+    @ResponseStatus(HttpStatus.OK)
+    public void update(@PathVariable("id") final Long id, @RequestBody final Foo resource) {
+        Preconditions.checkNotNull(resource);
+        RestPreconditions.checkFound(service.findOne(resource.getId()));
+        service.update(resource);
+    }
+
+    @DeleteMapping(value = "/{id}")
+    @ResponseStatus(HttpStatus.OK)
+    public void delete(@PathVariable("id") final Long id) {
+        service.deleteById(id);
+    }
 }

spring-boot-rest/src/main/java/com/baeldung/web/hateoas/event/SingleResourceRetrievedEvent.java

@@ -0,0 +1,22 @@
+package com.baeldung.web.hateoas.event;
+
+import javax.servlet.http.HttpServletResponse;
+
+import org.springframework.context.ApplicationEvent;
+
+public class SingleResourceRetrievedEvent extends ApplicationEvent {
+    private final HttpServletResponse response;
+
+    public SingleResourceRetrievedEvent(final Object source, final HttpServletResponse response) {
+        super(source);
+
+        this.response = response;
+    }
+
+    // API
+
+    public HttpServletResponse getResponse() {
+        return response;
+    }
+
+}

spring-boot-rest/src/main/java/com/baeldung/web/hateoas/listener/SingleResourceRetrievedDiscoverabilityListener.java

@@ -0,0 +1,34 @@
+package com.baeldung.web.hateoas.listener;
+
+import javax.servlet.http.HttpServletResponse;
+
+import com.baeldung.web.hateoas.event.SingleResourceRetrievedEvent;
+import com.baeldung.web.util.LinkUtil;
+import org.springframework.context.ApplicationListener;
+import org.springframework.stereotype.Component;
+import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
+
+import com.google.common.base.Preconditions;
+import com.google.common.net.HttpHeaders;
+
+@Component
+class SingleResourceRetrievedDiscoverabilityListener implements ApplicationListener<SingleResourceRetrievedEvent> {
+
+    @Override
+    public void onApplicationEvent(final SingleResourceRetrievedEvent resourceRetrievedEvent) {
+        Preconditions.checkNotNull(resourceRetrievedEvent);
+
+        final HttpServletResponse response = resourceRetrievedEvent.getResponse();
+        addLinkHeaderOnSingleResourceRetrieval(response);
+    }
+
+    void addLinkHeaderOnSingleResourceRetrieval(final HttpServletResponse response) {
+        final String requestURL = ServletUriComponentsBuilder.fromCurrentRequestUri().build().toUri().toASCIIString();
+        final int positionOfLastSlash = requestURL.lastIndexOf("/");
+        final String uriForResourceCreation = requestURL.substring(0, positionOfLastSlash);
+
+        final String linkHeaderValue = LinkUtil.createLinkHeader(uriForResourceCreation, "collection");
+        response.addHeader(HttpHeaders.LINK, linkHeaderValue);
+    }
+
+}

spring-boot-rest/src/test/java/com/baeldung/web/FooControllerAppIntegrationTest.java

@@ -0,0 +1,36 @@
+package com.baeldung.web;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+
+/**
+ * 
+ *  We'll start the whole context, but not the server. We'll mock the REST calls instead.
+ *
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest
+@AutoConfigureMockMvc
+public class FooControllerAppIntegrationTest {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @Test
+    public void whenFindPaginatedRequest_thenEmptyResponse() throws Exception {
+        this.mockMvc.perform(get("/auth/foos").param("page", "0")
+            .param("size", "2"))
+            .andExpect(status().isOk())
+            .andExpect(content().json("[]"));
+    }
+
+}

spring-boot-rest/src/test/java/com/baeldung/web/FooControllerWebLayerIntegrationTest.java

@@ -0,0 +1,60 @@
+package com.baeldung.web;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.when;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import java.util.Collections;
+
+import org.hamcrest.Matchers;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageImpl;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+
+import com.baeldung.persistence.model.Foo;
+import com.baeldung.persistence.service.IFooService;
+import com.baeldung.web.controller.FooController;
+import com.baeldung.web.hateoas.event.PaginatedResultsRetrievedEvent;
+
+/**
+ * 
+ *  We'll start only the web layer.
+ *
+ */
+@RunWith(SpringRunner.class)
+@WebMvcTest(FooController.class)
+public class FooControllerWebLayerIntegrationTest {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @MockBean
+    private IFooService service;
+
+    @MockBean
+    private ApplicationEventPublisher publisher;
+
+    @Test()
+    public void givenPresentFoo_whenFindPaginatedRequest_thenPageWithFooRetrieved() throws Exception {
+        Page<Foo> page = new PageImpl<>(Collections.singletonList(new Foo("fooName")));
+        when(service.findPaginated(0, 2)).thenReturn(page);
+        doNothing().when(publisher)
+            .publishEvent(any(PaginatedResultsRetrievedEvent.class));
+
+        this.mockMvc.perform(get("/auth/foos").param("page", "0")
+            .param("size", "2"))
+            .andExpect(status().isOk())
+            .andExpect(jsonPath("$",Matchers.hasSize(1)));
+    }
+
+}

spring-rest-full/README.md

@@ -16,7 +16,6 @@ The "Learn Spring Security" Classes: http://github.learnspringsecurity.com
 - [Project Configuration with Spring](http://www.baeldung.com/project-configuration-with-spring)
 - [Metrics for your Spring REST API](http://www.baeldung.com/spring-rest-api-metrics)
 - [Bootstrap a Web Application with Spring 4](http://www.baeldung.com/bootstraping-a-web-application-with-spring-and-java-based-configuration)
-- [Build a REST API with Spring and Java Config](http://www.baeldung.com/building-a-restful-web-service-with-spring-and-java-based-configuration)
 - [Spring Security Expressions - hasRole Example](https://www.baeldung.com/spring-security-expressions-basic)
 
 

spring-rest-full/src/main/java/org/baeldung/persistence/IOperations.java

@@ -16,11 +16,7 @@ public interface IOperations<T extends Serializable> {
     // write
 
     T create(final T entity);
-
+    
     T update(final T entity);
 
-    void delete(final T entity);
-
-    void deleteById(final long entityId);
-
 }

spring-rest-full/src/main/java/org/baeldung/persistence/service/common/AbstractService.java

@@ -40,16 +40,6 @@ public abstract class AbstractService<T extends Serializable> implements IOperat
         return getDao().save(entity);
     }
 
-    @Override
-    public void delete(final T entity) {
-        getDao().delete(entity);
-    }
-
-    @Override
-    public void deleteById(final long entityId) {
-        getDao().delete(entityId);
-    }
-
     protected abstract PagingAndSortingRepository<T, Long> getDao();
 
 }

spring-rest-full/src/main/java/org/baeldung/persistence/service/impl/FooService.java

@@ -1,7 +1,5 @@
 package org.baeldung.persistence.service.impl;
 
-import java.util.List;
-
 import org.baeldung.persistence.dao.IFooDao;
 import org.baeldung.persistence.model.Foo;
 import org.baeldung.persistence.service.IFooService;
@@ -11,8 +9,6 @@ import org.springframework.data.repository.PagingAndSortingRepository;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
-import com.google.common.collect.Lists;
-
 @Service
 @Transactional
 public class FooService extends AbstractService<Foo> implements IFooService {
@@ -38,12 +34,4 @@ public class FooService extends AbstractService<Foo> implements IFooService {
         return dao.retrieveByName(name);
     }
 
-    // overridden to be secured
-
-    @Override
-    @Transactional(readOnly = true)
-    public List<Foo> findAll() {
-        return Lists.newArrayList(getDao().findAll());
-    }
-
 }

spring-rest-full/src/main/java/org/baeldung/web/controller/FooController.java

@@ -80,20 +80,6 @@ public class FooController {
         return foo;
     }
 
-    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
-    @ResponseStatus(HttpStatus.OK)
-    public void update(@PathVariable("id") final Long id, @RequestBody final Foo resource) {
-        Preconditions.checkNotNull(resource);
-        RestPreconditions.checkFound(service.findOne(resource.getId()));
-        service.update(resource);
-    }
-
-    @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
-    @ResponseStatus(HttpStatus.OK)
-    public void delete(@PathVariable("id") final Long id) {
-        service.deleteById(id);
-    }
-
     @RequestMapping(method = RequestMethod.HEAD)
     @ResponseStatus(HttpStatus.OK)
     public void head(final HttpServletResponse resp) {