Add swagger-ui and paging

Author: stainboy

.gitignore

@@ -1,2 +1,3 @@
 .gradle/
+.idea/
 build/

README.md

@@ -6,25 +6,20 @@ A demo Java application leveraging Spring JPA with SAP HANA database.
 $ gradle build
 $ java -jar build/libs/springboot-jpa-hana-0.1.0.jar
 ```
-Then open browser and visit http://localhost:8080
+Then open browser and visit http://localhost:8080/swagger-ui.html
 
 ## How to run directly?
 ```bash
 $ gradle bootRun
 ```
-Then open browser and visit http://localhost:8080
+Then open browser and visit http://localhost:8080/swagger-ui.html
 
 ## How to run with Docker?
 ```bash
 $ docker build -t springboot-jpa-hana .
 $ docker run -p 8080:8080 springboot-jpa-hana
 ```
-Then open browser and visit http://localhost:8080
-
-## How to generate some test data?
-```bash
-$ curl -i localhost:8080/users/ -F name=John_Doe -F email=foo@bar.com -F locale=en
-```
+Then open browser and visit http://localhost:8080/swagger-ui.html
 
 ## Caveats
 - The solution only works with HANA 2.0 because it requires `select hibernate_sequence.nextval from sys.dummy` when auto generates Id.

build.gradle

@@ -14,7 +14,7 @@ apply plugin: 'org.springframework.boot'
 apply plugin: 'io.spring.dependency-management'
 
 bootJar {
-    baseName = 'springboot-jpa-hana'
+    archiveBaseName = 'springboot-jpa-hana'
     version =  '0.1.0'
 }
 
@@ -34,6 +34,12 @@ dependencies {
     // tag::actuator[]
     compile("org.springframework.boot:spring-boot-starter-actuator")
     // end::actuator[]
+    // tag::swagger[]
+    compile("io.springfox:springfox-swagger2:2.9.2")
+    compile("io.springfox:springfox-swagger-ui:2.9.2")
+    // https://github.com/swagger-api/swagger-core/issues/2783
+    compile("io.swagger:swagger-models:1.6.0")
+    // end::swagger[]
     // tag::tests[]
     testCompile("org.springframework.boot:spring-boot-starter-test")
     testCompile("com.h2database:h2")

src/main/java/com/sap/demo/HelloController.java

@@ -10,7 +10,7 @@ public class HelloController {
     @Autowired
     Environment env;
 
-    @RequestMapping("/")
+    @GetMapping("/")
     public String index() {
         return "Greetings from Spring Boot!";
     }

src/main/java/com/sap/demo/NotFoundError.java

@@ -0,0 +1,42 @@
+package com.sap.demo;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+import java.util.ArrayList;
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig {
+    /**
+     * Every Docket bean is picked up by the swagger-mvc framework - allowing for multiple
+     * swagger groups i.e. same code base multiple swagger resource listings.
+     */
+    @Bean
+    public Docket customDocket() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .select()
+//                .apis(RequestHandlerSelectors.any())
+                .apis(RequestHandlerSelectors.basePackage("com.sap.demo"))
+//                .paths(PathSelectors.regex("/v1/.*"))
+                .build().apiInfo(apiInfo());
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfo(
+                "SpringBoot JPA with SAP HANA",
+                "A demo Java application leveraging Spring JPA with SAP HANA database",
+                "0.1.0",
+                "Terms of service",
+                new Contact("John Doe", "", "foo@bar.com"),
+                "License of API",
+                "https://swagger.io/docs/",
+                new ArrayList<>());
+    }
+}

src/main/java/com/sap/demo/SwaggerConfig.java

@@ -1,43 +1,67 @@
 package com.sap.demo;
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
+import javax.validation.Valid;
+import java.util.Optional;
+
 @RestController()
-@RequestMapping(path = "/users")
+@RequestMapping(path = "/v1/users")
 public class UserController {
 
-    @Autowired // This means to get the bean called userRepository
-    // Which is auto-generated by Spring, we will use it to handle the data
-    private UserRepository userRepository;
+    private static final String DEFAULT_PAGE_SIZE = "10";
+    private static final String DEFAULT_PAGE_INDEX = "0";
+    private static final String DEFAULT_PAGE_SORT_DIRECTION = "ASC";
+
+
+    @Autowired
+    private UserService userService;
+
 
-    @PostMapping(path = "/") // Map ONLY GET Requests
+    @PostMapping()
+    @ApiOperation(
+            value = "Add a new user",
+            notes = "Returns the same user added.",
+            response = User.class)
     public @ResponseBody
-    User addUser(@RequestParam String name
-            , @RequestParam String email
-            , @RequestParam String locale) {
-        // @ResponseBody means the returned String is the response, not a view name
-        // @RequestParam means it is a parameter from the GET or POST request
-
-        User n = new User();
-        n.setName(name);
-        n.setEmail(email);
-        n.setLocale(locale);
-        userRepository.save(n);
-        return n;
+    ResponseEntity<User> addUser(@Valid @RequestBody User user) {
+        userService.save(user);
+        return ResponseEntity.ok().body(user);
     }
 
-    @GetMapping(path = "/")
+    @GetMapping()
+    @ApiOperation(
+            value = "Get all users",
+            notes = "Returns first N users specified by the size parameter with page offset specified by page parameter.",
+            response = Page.class)
     public @ResponseBody
-    Iterable<User> getAllUsers() {
-        // This returns a JSON or XML with the users
-        return userRepository.findAll();
+    Page<User> getAllUsers(
+            @ApiParam("The size of the page to be returned") @RequestParam(required = false, defaultValue = DEFAULT_PAGE_SIZE) Integer pageSize,
+            @ApiParam("Zero-based page index") @RequestParam(required = false, defaultValue = DEFAULT_PAGE_INDEX) Integer pageNo,
+            @ApiParam("Field name to sort by") @RequestParam(required = false, defaultValue = "name") String sortBy,
+            @ApiParam("Direction to sort by") @RequestParam(required = false, defaultValue = DEFAULT_PAGE_SORT_DIRECTION) Sort.Direction direction
+    ) {
+        Pageable paging = PageRequest.of(pageNo, pageSize, direction, sortBy);
+        return userService.findAll(paging);
     }
 
     @GetMapping(path = "/{email}")
+    @ApiOperation(
+            value = "Find user by email address",
+            notes = "Returns the user matched by the given email.",
+            response = User.class)
     public @ResponseBody
-    User getUserByEmail(@PathVariable("email") String email) {
-        return userRepository.findByEmail(email).orElseThrow(() -> new NotFoundError());
+    ResponseEntity<User> getUserByEmail(@PathVariable("email") String email) {
+        Optional<User> user = userService.findByEmail(email);
+        return ResponseEntity.of(user);
     }
 
 }

src/main/java/com/sap/demo/UserController.java

@@ -1,14 +1,14 @@
 package com.sap.demo;
 
-import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.jpa.repository.JpaRepository;
 
 import java.util.Optional;
 
 
 // This will be AUTO IMPLEMENTED by Spring into a Bean called userRepository
 // CRUD refers Create, Read, Update, Delete
 
-public interface UserRepository extends CrudRepository<User, Integer> {
+public interface UserRepository extends JpaRepository<User, Integer> {
 
-    public Optional<User> findByEmail(String email);
+    Optional<User> findByEmail(String email);
 }

src/main/java/com/sap/demo/UserRepository.java

@@ -0,0 +1,41 @@
+package com.sap.demo;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.Optional;
+
+
+@Service
+@Transactional
+public class UserService {
+
+    @Autowired
+    private UserRepository repository;
+
+    @Transactional(readOnly = true)
+    Page<User> findAll(Pageable pageable) {
+
+        return repository.findAll(pageable);
+    }
+
+    @Transactional(readOnly = true)
+    Optional<User> findById(Integer id) {
+        return repository.findById(id);
+    }
+
+    @Transactional()
+    User save(User user) {
+        return repository.saveAndFlush(user);
+    }
+
+    @Transactional(readOnly = true)
+    Optional<User> findByEmail(String email) {
+        return repository.findByEmail(email);
+    }
+
+
+}