Sping Boot REST api validation

Author: giaunv

springboot-examples/springboot-restapi-validation/pom.xml

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.hellokoding.springboot</groupId>
+    <artifactId>springboot-restapi-validation</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.1.4.RELEASE</version>
+    </parent>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <java.version>1.8</java.version>
+        <org.apache.maven.plugins.version>3.6.0</org.apache.maven.plugins.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-jpa</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.hsqldb</groupId>
+            <artifactId>hsqldb</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+</project>

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/Application.java

@@ -0,0 +1,11 @@
+package com.hellokoding.springboot.restful;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/ExceptionHandler.java

@@ -0,0 +1,28 @@
+package com.hellokoding.springboot.restful;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+@ControllerAdvice
+@Slf4j
+@RequiredArgsConstructor
+public class ExceptionHandler extends ResponseEntityExceptionHandler {
+    @Override
+    protected ResponseEntity handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
+        log.error(ex.getMessage(), ex);
+
+        ResponseDTO responseDTO = ResponseDTO.builder()
+            .status(status.toString())
+            .message(ex.getBindingResult().getFieldError().getDefaultMessage())
+            .body(ex.getBindingResult().getTarget()).build();
+
+        return ResponseEntity.badRequest().body(responseDTO);
+    }
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/ResponseDTO.java

@@ -0,0 +1,12 @@
+package com.hellokoding.springboot.restful;
+
+import lombok.Builder;
+import lombok.Data;
+
+@Data
+@Builder
+public class ResponseDTO<T> {
+    private String status;
+    private String message;
+    private T body;
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/product/Product.java

@@ -0,0 +1,30 @@
+package com.hellokoding.springboot.restful.product;
+
+import lombok.Data;
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.validation.constraints.Min;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Size;
+import java.math.BigDecimal;
+
+@Data
+@Entity
+public class Product {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @ProductIDExisting
+    private Long id;
+
+    @NotNull(message = "{NotNull.name}")
+    private String name;
+
+    @Size(max = 100)
+    private String description;
+
+    @Min(1)
+    private BigDecimal price;
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/product/ProductAPI.java

@@ -0,0 +1,48 @@
+package com.hellokoding.springboot.restful.product;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+import javax.validation.Valid;
+import java.util.List;
+
+
+@RestController
+@RequestMapping("/api/v1/products")
+public class ProductAPI {
+    private final ProductService productService;
+
+    @Autowired
+    public ProductAPI(ProductService productService) {
+        this.productService = productService;
+    }
+
+    @GetMapping
+    public ResponseEntity<List<Product>> findAll() {
+        return ResponseEntity.ok(productService.findAll());
+    }
+
+    @GetMapping("/{id}")
+    public ResponseEntity<Product> findById(@PathVariable @ProductIDExisting Long id) {
+        return ResponseEntity.ok(productService.findById(id).get());
+    }
+
+    @PostMapping
+    public ResponseEntity<Product> create(@Valid @RequestBody Product product) {
+        return ResponseEntity.status(HttpStatus.CREATED).body(productService.save(product));
+    }
+
+    @PutMapping("/{id}")
+    public ResponseEntity<Product> update(@PathVariable Long id, @Valid @RequestBody Product product) {
+        return ResponseEntity.accepted().body(productService.save(product));
+    }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity delete(@PathVariable @ProductIDExisting Long id) {
+        productService.deleteById(id);
+
+        return ResponseEntity.accepted().build();
+    }
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/product/ProductIDExisting.java

@@ -0,0 +1,17 @@
+package com.hellokoding.springboot.restful.product;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+import java.lang.annotation.*;
+
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.FIELD, ElementType.PARAMETER})
+@Constraint(validatedBy = ProductIDExistingValidator.class)
+public @interface ProductIDExisting {
+    String message() default "{ProductIDExisting}";
+
+    Class<?>[] groups() default { };
+
+    Class<? extends Payload>[] payload() default { };
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/product/ProductIDExistingValidator.java

@@ -0,0 +1,21 @@
+package com.hellokoding.springboot.restful.product;
+
+import lombok.NoArgsConstructor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+import java.util.Objects;
+
+@Component
+@NoArgsConstructor
+public class ProductIDExistingValidator implements ConstraintValidator<ProductIDExisting, Long> {
+    @Autowired
+    private ProductService productService;
+
+    @Override
+    public boolean isValid(Long productId, ConstraintValidatorContext context) {
+        return Objects.isNull(productId) || productService.findById(productId).isPresent();
+    }
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/product/ProductRepository.java

@@ -0,0 +1,6 @@
+package com.hellokoding.springboot.restful.product;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface ProductRepository extends JpaRepository<Product, Long> {
+}

springboot-examples/springboot-restapi-validation/src/main/java/com/hellokoding/springboot/restful/product/ProductService.java

@@ -0,0 +1,33 @@
+package com.hellokoding.springboot.restful.product;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+import java.util.Optional;
+
+@Service
+public class ProductService {
+    private final ProductRepository productRepository;
+
+    @Autowired
+    public ProductService(ProductRepository productRespository) {
+        this.productRepository = productRespository;
+    }
+
+    public List<Product> findAll() {
+        return productRepository.findAll();
+    }
+
+    public Optional<Product> findById(Long id) {
+        return productRepository.findById(id);
+    }
+
+    public Product save(Product stock) {
+        return productRepository.save(stock);
+    }
+
+    public void deleteById(Long id) {
+        productRepository.deleteById(id);
+    }
+}