created API

GarikSlavsky · GarikSlavsky · commit e594f47d338b · 2025-02-05T18:16:11.000+02:00
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 - Task: Create API. It should contain two methods:
 
-1. The request randomly generates a wiki about one character in the universe the animated series Rick & Morty.
+1. The request randomly generates a wiki about one personage in the universe the animated series Rick & Morty.
    Response example:
 
     ```json
@@ -17,7 +17,7 @@
     }
     ```
     
-    NOTE: `externalId` field should save the original character ID received from the external API. `id` field should
+    NOTE: `externalId` field should save the original personage ID received from the external API. `id` field should
     represent the identifier of entire `Character` entity, that is associated with internal DB.
 
 2. The request takes a string as an argument, and returns a list of all characters whose name contains the search
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>3.1.4</version>
+		<version>3.4.1</version>
 		<relativePath/>
 	</parent>
 	<groupId>mate.academy</groupId>
@@ -19,30 +19,80 @@
 		<maven.checkstyle.plugin.configLocation>
 			https://raw.githubusercontent.com/mate-academy/style-guides/master/java/checkstyle.xml
 		</maven.checkstyle.plugin.configLocation>
+		<lombok.mapstruct.binding.version>0.2.0</lombok.mapstruct.binding.version>
+		<mapstruct.version>1.6.3</mapstruct.version>
+		<springdoc.version>2.8.4</springdoc.version>
 	</properties>
 	<dependencies>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
-
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-data-jpa</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>com.h2database</groupId>
 			<artifactId>h2</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>com.mysql</groupId>
+			<artifactId>mysql-connector-j</artifactId>
+			<scope>runtime</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+			<scope>annotationProcessor</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.hibernate.orm</groupId>
+			<artifactId>hibernate-core</artifactId>
+			<version>6.6.4.Final</version>
+			<scope>compile</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct</artifactId>
+			<version>${mapstruct.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct-processor</artifactId>
+			<version>1.5.1.Final</version>
+			<scope>provided</scope>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-databind</artifactId>
+			<version>2.18.2</version>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-core</artifactId>
+			<version>2.18.2</version>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-annotations</artifactId>
+			<version>2.18.2</version>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+			<version>${springdoc.version}</version>
+		</dependency>
 	</dependencies>
-
 	<build>
 		<plugins>
 			<plugin>
@@ -62,6 +112,7 @@
 					</execution>
 				</executions>
 				<configuration>
+					<sourceDirectories>src</sourceDirectories>
 					<configLocation>${maven.checkstyle.plugin.configLocation}</configLocation>
 					<consoleOutput>true</consoleOutput>
 					<failsOnError>true</failsOnError>
diff --git a/src/main/java/mate/academy/rickandmorty/config/MapperConfig.java b/src/main/java/mate/academy/rickandmorty/config/MapperConfig.java
@@ -0,0 +1,13 @@
+package mate.academy.rickandmorty.config;
+
+import org.mapstruct.InjectionStrategy;
+import org.mapstruct.NullValueCheckStrategy;
+
+@org.mapstruct.MapperConfig(
+        componentModel = "spring",
+        injectionStrategy = InjectionStrategy.CONSTRUCTOR,
+        nullValueCheckStrategy = NullValueCheckStrategy.ALWAYS,
+        implementationPackage = "<PACKAGE_NAME>.impl"
+)
+public class MapperConfig {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/controller/PersonageController.java b/src/main/java/mate/academy/rickandmorty/controller/PersonageController.java
@@ -0,0 +1,36 @@
+package mate.academy.rickandmorty.controller;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import mate.academy.rickandmorty.dto.internal.PersonageDto;
+import mate.academy.rickandmorty.service.PersonageService;
+import org.springframework.data.domain.Pageable;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestController;
+
+@Tag(name = "Book management", description = "Endpoints for managing books.")
+@RestController
+@RequestMapping("personages")
+@RequiredArgsConstructor
+public class PersonageController {
+    private final PersonageService personageService;
+
+    @GetMapping
+    @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "Get a random personage.")
+    public PersonageDto getPersonage() {
+        return personageService.getRandomPersonage();
+    }
+
+    @GetMapping("/search")
+    @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "Filtering and sorting personages by name.")
+    public List<PersonageDto> searchPersonage(String name, Pageable pageable) {
+        return personageService.searchPersonage(name, pageable);
+    }
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dto/external/InfoDto.java b/src/main/java/mate/academy/rickandmorty/dto/external/InfoDto.java
@@ -0,0 +1,7 @@
+package mate.academy.rickandmorty.dto.external;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public record InfoDto(int count, int pages, String next, String prev) {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dto/external/ResponseDto.java b/src/main/java/mate/academy/rickandmorty/dto/external/ResponseDto.java
@@ -0,0 +1,15 @@
+package mate.academy.rickandmorty.dto.external;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import java.util.List;
+import lombok.Data;
+import mate.academy.rickandmorty.dto.internal.CreatePersonageRequestDto;
+import org.springframework.stereotype.Component;
+
+@Data
+@JsonIgnoreProperties(ignoreUnknown = true)
+@Component
+public class ResponseDto {
+    private List<CreatePersonageRequestDto> results;
+    private InfoDto info;
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dto/internal/CreatePersonageRequestDto.java b/src/main/java/mate/academy/rickandmorty/dto/internal/CreatePersonageRequestDto.java
@@ -0,0 +1,28 @@
+package mate.academy.rickandmorty.dto.internal;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Positive;
+import lombok.Data;
+
+@Data
+@Schema(description = "Request DTO for creating a new personage.")
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class CreatePersonageRequestDto {
+    @Positive
+    @Schema(description = "The ID of the personage.", example = "12")
+    private Long id;
+
+    @NotBlank
+    @Schema(description = "The name of the personage.", example = "Beth Smith")
+    private String name;
+
+    @NotBlank
+    @Schema(description = "The status of the personage.", example = "Alive")
+    private String status;
+
+    @NotBlank
+    @Schema(description = "The gender of the personage.", example = "Female")
+    private String gender;
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dto/internal/PersonageDto.java b/src/main/java/mate/academy/rickandmorty/dto/internal/PersonageDto.java
@@ -0,0 +1,8 @@
+package mate.academy.rickandmorty.dto.internal;
+
+public record PersonageDto(Long id,
+                           Long externalId,
+                           String name,
+                           String status,
+                           String gender) {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/mapper/PersonageMapper.java b/src/main/java/mate/academy/rickandmorty/mapper/PersonageMapper.java
@@ -0,0 +1,17 @@
+package mate.academy.rickandmorty.mapper;
+
+import mate.academy.rickandmorty.config.MapperConfig;
+import mate.academy.rickandmorty.dto.internal.CreatePersonageRequestDto;
+import mate.academy.rickandmorty.dto.internal.PersonageDto;
+import mate.academy.rickandmorty.model.Personage;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+
+@Mapper(config = MapperConfig.class)
+public interface PersonageMapper {
+    PersonageDto intoDto(Personage personage);
+
+    @Mapping(target = "id", ignore = true)
+    @Mapping(target = "externalId", source = "id")
+    Personage intoModel(CreatePersonageRequestDto requestDto);
+}
diff --git a/src/main/java/mate/academy/rickandmorty/model/Personage.java b/src/main/java/mate/academy/rickandmorty/model/Personage.java
@@ -0,0 +1,39 @@
+package mate.academy.rickandmorty.model;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+import lombok.Getter;
+import lombok.Setter;
+import org.hibernate.annotations.SQLDelete;
+import org.hibernate.annotations.SQLRestriction;
+
+@Entity
+@Table(name = "personages")
+@SQLDelete(sql = "UPDATE characters SET is_deleted = true WHERE id = ?")
+@SQLRestriction(value = "is_deleted = false")
+@Getter
+@Setter
+public class Personage {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false)
+    private Long externalId;
+
+    @Column(nullable = false)
+    private String name;
+
+    @Column(nullable = false)
+    private String status;
+
+    @Column(nullable = false)
+    private String gender;
+
+    @Column(nullable = false)
+    private boolean isDeleted = false;
+}
diff --git a/src/main/java/mate/academy/rickandmorty/repository/PersonageRepository.java b/src/main/java/mate/academy/rickandmorty/repository/PersonageRepository.java
@@ -0,0 +1,9 @@
+package mate.academy.rickandmorty.repository;
+
+import mate.academy.rickandmorty.model.Personage;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
+
+public interface PersonageRepository extends JpaRepository<Personage, Long>,
+        JpaSpecificationExecutor<Personage> {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationBuilder.java b/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationBuilder.java
@@ -0,0 +1,8 @@
+package mate.academy.rickandmorty.repository.specification;
+
+import mate.academy.rickandmorty.model.Personage;
+import org.springframework.data.jpa.domain.Specification;
+
+public interface SpecificationBuilder {
+    Specification<Personage> buildSpecification(String name);
+}
diff --git a/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationBuilderImpl.java b/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationBuilderImpl.java
@@ -0,0 +1,26 @@
+package mate.academy.rickandmorty.repository.specification;
+
+import lombok.RequiredArgsConstructor;
+import mate.academy.rickandmorty.model.Personage;
+import org.springframework.data.jpa.domain.Specification;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class SpecificationBuilderImpl implements SpecificationBuilder {
+    private final SpecificationProvider provider;
+
+    @Override
+    public Specification<Personage> buildSpecification(String name) {
+        Specification<Personage> spec = Specification.where(null);
+        if (parameterValidator(name)) {
+            spec = spec.and(provider.getSpecification(name));
+        }
+
+        return spec;
+    }
+
+    private boolean parameterValidator(String parameter) {
+        return parameter != null && !parameter.isEmpty();
+    }
+}
diff --git a/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationProvider.java b/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationProvider.java
@@ -0,0 +1,8 @@
+package mate.academy.rickandmorty.repository.specification;
+
+import mate.academy.rickandmorty.model.Personage;
+import org.springframework.data.jpa.domain.Specification;
+
+public interface SpecificationProvider {
+    Specification<Personage> getSpecification(String name);
+}
diff --git a/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationProviderImpl.java b/src/main/java/mate/academy/rickandmorty/repository/specification/SpecificationProviderImpl.java
@@ -0,0 +1,17 @@
+package mate.academy.rickandmorty.repository.specification;
+
+import mate.academy.rickandmorty.model.Personage;
+import org.springframework.data.jpa.domain.Specification;
+import org.springframework.stereotype.Component;
+
+@Component
+public class SpecificationProviderImpl implements SpecificationProvider {
+    private static final String DETERMINER = "name";
+
+    @Override
+    public Specification<Personage> getSpecification(String name) {
+        return (root, query, criteriaBuilder) -> criteriaBuilder.like(
+                root.get(DETERMINER), "%" + name + "%"
+        );
+    }
+}
diff --git a/src/main/java/mate/academy/rickandmorty/service/DataFetcher.java b/src/main/java/mate/academy/rickandmorty/service/DataFetcher.java
diff --git a/src/main/java/mate/academy/rickandmorty/service/PersonageClient.java b/src/main/java/mate/academy/rickandmorty/service/PersonageClient.java
diff --git a/src/main/java/mate/academy/rickandmorty/service/PersonageService.java b/src/main/java/mate/academy/rickandmorty/service/PersonageService.java
diff --git a/src/main/java/mate/academy/rickandmorty/service/PersonageServiceImpl.java b/src/main/java/mate/academy/rickandmorty/service/PersonageServiceImpl.java
diff --git a/src/test/java/mate/academy/rickandmorty/ApplicationTests.java b/src/test/java/mate/academy/rickandmorty/ApplicationTests.java
