learn rest-api ch03

Author: zacscoding

Diff for: book/rest-api-demo/pom.xml

@@ -74,7 +74,7 @@
         <dependency>
             <groupId>com.h2database</groupId>
             <artifactId>h2</artifactId>
-            <!--<scope>test</scope>-->
+            <scope>test</scope>
         </dependency>
 
         <!-- model mapper -->

Diff for: book/rest-api-demo/scripts.md

@@ -0,0 +1,81 @@
+# Scripts
+
+Here, I memo scripts that I have used during development.
+
+## Postgres
+
+### Run Postgres Container
+
+```
+docker run --name ndb -p 5432:5432 -e POSTGRES_PASSWORD=pass -d postgres
+
+```
+
+This cmdlet will create Postgres instance so that you can connect to a database with:
+* database: postgres
+* username: postgres
+* password: pass
+* post: 5432
+
+### Getting into the Postgres container
+
+```
+docker exec -i -t ndb bash
+```
+
+Then you will see the containers bash as a root user.
+
+### Connect to a database
+
+```
+psql -d postgres -U postgres
+```
+
+### Query Databases
+
+```
+\l
+```
+
+### Query Tables
+
+```
+\dt
+```
+
+### Quit
+
+```
+\q
+```
+
+## application.properties
+
+### Datasource
+
+```
+spring.datasource.username=postgres
+spring.datasource.password=pass
+spring.datasource.url=jdbc:postgresql://localhost:5432/postgres
+spring.datasource.driver-class-name=org.postgresql.Driver
+```
+
+### Hibernate
+
+```
+spring.jpa.hibernate.ddl-auto=create-drop
+spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
+spring.jpa.properties.hibernate.format_sql=true
+
+logging.level.org.hibernate.SQL=DEBUG
+logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
+```
+
+### Test Database
+
+```
+spring.datasource.username=sa
+spring.datasource.password=
+spring.datasource.url=jdbc:h2:mem:testdb
+spring.datasource.driver-class-name=org.h2.Driver
+```

Diff for: book/rest-api-demo/src/main/java/demo/common/ErrorsResource.java

@@ -0,0 +1,21 @@
+package demo.common;
+
+import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;
+import static org.springframework.hateoas.mvc.ControllerLinkBuilder.methodOn;
+
+import demo.index.IndexController;
+import org.springframework.hateoas.Link;
+import org.springframework.hateoas.Resource;
+import org.springframework.validation.Errors;
+
+/**
+ * https://github.com/keesun/study/tree/master/rest-api-with-spring
+ */
+public class ErrorsResource extends Resource<Errors> {
+
+    public ErrorsResource(Errors content, Link... links) {
+        super(content, links);
+
+        add(linkTo(methodOn(IndexController.class).index()).withRel("index"));
+    }
+}

Diff for: book/rest-api-demo/src/main/java/demo/events/EventController.java

@@ -2,6 +2,7 @@
 
 import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;
 
+import demo.common.ErrorsResource;
 import java.net.URI;
 import javax.validation.Valid;
 import org.modelmapper.ModelMapper;
@@ -38,12 +39,12 @@ public EventController(EventRepository eventRepository, ModelMapper modelMapper,
     @PostMapping
     public ResponseEntity createEvent(@RequestBody @Valid EventDto eventDto, Errors errors) {
         if (errors.hasErrors()) {
-            return ResponseEntity.badRequest().body(errors);
+            return badRequest(errors);
         }
 
         eventValidator.validate(eventDto, errors);
         if (errors.hasErrors()) {
-            return ResponseEntity.badRequest().body(errors);
+            return badRequest(errors);
         }
 
         Event event = modelMapper.map(eventDto, Event.class);
@@ -59,4 +60,8 @@ public ResponseEntity createEvent(@RequestBody @Valid EventDto eventDto, Errors
 
         return ResponseEntity.created(createdUri).body(eventResource);
     }
+
+    private ResponseEntity badRequest(Errors errors) {
+        return ResponseEntity.badRequest().body(new ErrorsResource(errors));
+    }
 }

Diff for: book/rest-api-demo/src/main/java/demo/index/IndexController.java

@@ -0,0 +1,22 @@
+package demo.index;
+
+import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;
+
+import demo.events.EventController;
+import org.springframework.hateoas.ResourceSupport;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * https://github.com/keesun/study/tree/master/rest-api-with-spring
+ */
+@RestController
+public class IndexController {
+
+    @GetMapping("/api")
+    public ResourceSupport index() {
+        ResourceSupport index = new ResourceSupport();
+        index.add(linkTo(EventController.class).withRel("events"));
+        return index;
+    }
+}

Diff for: book/rest-api-demo/src/main/resources/application.properties

@@ -1 +1,15 @@
-spring.jackson.deserialization.fail-on-unknown-properties=true
+spring.jackson.deserialization.fail-on-unknown-properties=true
+
+# Datasource
+spring.datasource.username=postgres
+spring.datasource.password=pass
+spring.datasource.url=jdbc:postgresql://192.168.79.130:5432/postgres
+spring.datasource.driver-class-name=org.postgresql.Driver
+
+# Hibernate
+spring.jpa.hibernate.ddl-auto=create-drop
+spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
+spring.jpa.properties.hibernate.format_sql=true
+
+logging.level.org.hibernate.SQL=DEBUG
+logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE

Diff for: book/rest-api-demo/src/test/java/demo/events/EventControllerTests.java

@@ -30,6 +30,7 @@
 import org.springframework.hateoas.MediaTypes;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.MediaType;
+import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.web.servlet.MockMvc;
 
@@ -43,6 +44,7 @@
 @Import({
     RestDocsConfiguration.class
 })
+@ActiveProfiles("test")
 public class EventControllerTests {
 
     @Autowired
@@ -197,8 +199,9 @@ public void createEvent_Bad_Request_Wrong_Input() throws Exception {
             .content(objectMapper.writeValueAsString(eventDto)))
             .andDo(print())
             .andExpect(status().isBadRequest())
-            .andExpect(jsonPath("$[0].objectName").exists())
-            .andExpect(jsonPath("$[0].defaultMessage").exists())
-            .andExpect(jsonPath("$[0].code").exists());
+            .andExpect(jsonPath("content[0].objectName").exists())
+            .andExpect(jsonPath("content[0].defaultMessage").exists())
+            .andExpect(jsonPath("content[0].code").exists())
+            .andExpect(jsonPath("_links.index").exists());
     }
 }

Diff for: book/rest-api-demo/src/test/java/demo/index/IndexControllerTest.java

@@ -0,0 +1,41 @@
+package demo.index;
+
+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 demo.common.RestDocsConfiguration;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Import;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+
+/**
+ * https://github.com/keesun/study/tree/master/rest-api-with-spring
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest
+@AutoConfigureMockMvc
+@AutoConfigureRestDocs
+@Import({
+    RestDocsConfiguration.class
+})
+@ActiveProfiles("test")
+public class IndexControllerTest {
+
+    @Autowired
+    MockMvc mockMvc;
+
+    @Test
+    public void index() throws Exception {
+        mockMvc.perform(get("/api/"))
+            .andExpect(status().isOk())
+            .andExpect(jsonPath("_links.events").exists());
+    }
+}

Diff for: book/rest-api-demo/src/test/resources/application-test.properties

@@ -0,0 +1,7 @@
+spring.datasource.username=sa
+spring.datasource.password=
+spring.datasource.url=jdbc:h2:mem:testdb
+spring.datasource.driver-class-name=org.h2.Driver
+
+spring.datasource.hikari.jdbc-url=jdbc:h2:mem:testdb
+spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.H2Dialect