Spring Boot - Working with third-party API

pom.xml

@@ -19,13 +19,19 @@
 		<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>
 	</properties>
 	<dependencies>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
@@ -41,14 +47,86 @@
 			<groupId>com.h2database</groupId>
 			<artifactId>h2</artifactId>
 		</dependency>
+
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>com.mysql</groupId>
+			<artifactId>mysql-connector-j</artifactId>
+			<scope>runtime</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct</artifactId>
+			<version>1.5.5.Final</version>
+		</dependency>
+
+		<dependency>
+			<groupId>com.h2database</groupId>
+			<artifactId>h2</artifactId>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.liquibase</groupId>
+			<artifactId>liquibase-core</artifactId>
+			<version>${liquibase.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.liquibase</groupId>
+			<artifactId>liquibase-maven-plugin</artifactId>
+			<version>${liquibase.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.hibernate</groupId>
+			<artifactId>hibernate-validator</artifactId>
+			<version>8.0.1.Final</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-validation</artifactId>
+			<version>3.1.4</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+			<version>2.2.0</version>
+		</dependency>
+
 	</dependencies>
 
 	<build>
+
+		<resources>
+			<resource>
+				<directory>src/main/resources</directory>
+				<filtering>true</filtering>
+			</resource>
+		</resources>
+
 		<plugins>
+
 			<plugin>
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
+				<configuration>
+					<excludes>
+						<exclude>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok</artifactId>
+						</exclude>
+					</excludes>
+				</configuration>
 			</plugin>
+
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-checkstyle-plugin</artifactId>
@@ -66,9 +144,48 @@
 					<consoleOutput>true</consoleOutput>
 					<failsOnError>true</failsOnError>
 					<linkXRef>false</linkXRef>
+					<sourceDirectories>src</sourceDirectories>
 				</configuration>
 			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>3.11.0</version>
+				<configuration>
+					<source>1.8</source>
+					<target>1.8</target>
+					<annotationProcessorPaths>
+						<path>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok</artifactId>
+							<version>${lombok.version}</version>
+						</path>
+						<path>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok-mapstruct-binding</artifactId>
+							<version>${lombok.mapstruct.binding.version}</version>
+						</path>
+						<path>
+							<groupId>org.mapstruct</groupId>
+							<artifactId>mapstruct-processor</artifactId>
+							<version>1.5.5.Final</version>
+						</path>
+					</annotationProcessorPaths>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.liquibase</groupId>
+				<artifactId>liquibase-maven-plugin</artifactId>
+				<version>${liquibase.version}</version>
+				<configuration>
+					<propertyFile>src/main/resources/liquibase.properties</propertyFile>
+				</configuration>
+			</plugin>
+
 		</plugins>
+
 	</build>
 
 </project>

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 {
+}

src/main/java/mate/academy/rickandmorty/controler/CharacterController.java

@@ -0,0 +1,45 @@
+package mate.academy.rickandmorty.controler;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+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.CharacterDto;
+import mate.academy.rickandmorty.dto.internal.CharacterSearchParametersDto;
+import mate.academy.rickandmorty.service.CharacterService;
+import org.springframework.data.domain.Pageable;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@Tag(name = "Characters management", description = "Endpoints for managing characters")
+@RestController
+@RequiredArgsConstructor
+@RequestMapping(value = "/api/characters")
+@OpenAPIDefinition
+public class CharacterController {
+    private final CharacterService characterService;
+
+    @GetMapping("/character")
+    @Operation(summary = "Get one Character", description = "The request randomly generates "
+            + "a wiki about one character in the universe the animated series Rick & Morty.")
+    public CharacterDto findByRandomId() {
+        return characterService.findByRandomId();
+    }
+
+    @GetMapping("/search/name")
+    @Operation(summary = "Find all Characters by name", description =
+            "Get a list of all Characters according to the name")
+    List<CharacterDto> searchCharactersByName(CharacterSearchParametersDto searchParametersDto,
+                                        Pageable pageable) {
+        return characterService.searchCharactersByName(searchParametersDto, pageable);
+    }
+
+    @GetMapping
+    @Operation(summary = "Get all characters", description = "Get a list of all "
+            + "available characters")
+    public List<CharacterDto> getAll(Pageable pageable) {
+        return characterService.getAll(pageable);
+    }
+}

src/main/java/mate/academy/rickandmorty/dto/external/CharacterResponseDataDto.java

@@ -0,0 +1,9 @@
+package mate.academy.rickandmorty.dto.external;
+
+import java.util.List;
+import lombok.Data;
+
+@Data
+public class CharacterResponseDataDto {
+    private List<CharacterResults> results;
+}

src/main/java/mate/academy/rickandmorty/dto/external/CharacterResults.java

@@ -0,0 +1,9 @@
+package mate.academy.rickandmorty.dto.external;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public record CharacterResults(@JsonProperty("id") String externalId,
+                               String name,
+                               String status,
+                               String gender) {
+}

src/main/java/mate/academy/rickandmorty/dto/internal/CharacterDto.java

@@ -0,0 +1,12 @@
+package mate.academy.rickandmorty.dto.internal;
+
+import lombok.Data;
+
+@Data
+public class CharacterDto {
+    private Long id;
+    private String externalId;
+    private String name;
+    private String status;
+    private String gender;
+}

src/main/java/mate/academy/rickandmorty/dto/internal/CharacterSearchParametersDto.java

@@ -0,0 +1,4 @@
+package mate.academy.rickandmorty.dto.internal;
+
+public record CharacterSearchParametersDto(String name) {
+}

src/main/java/mate/academy/rickandmorty/mapper/CharacterMapper.java

@@ -0,0 +1,16 @@
+package mate.academy.rickandmorty.mapper;
+
+import mate.academy.rickandmorty.config.MapperConfig;
+import mate.academy.rickandmorty.dto.external.CharacterResults;
+import mate.academy.rickandmorty.dto.internal.CharacterDto;
+import mate.academy.rickandmorty.model.Character;
+import org.mapstruct.Mapper;
+
+@Mapper(config = MapperConfig.class)
+public interface CharacterMapper {
+    CharacterDto toDto(Character character);
+
+    CharacterDto fromApiToDto(CharacterResults characterResults);
+
+    Character toModel(CharacterDto characterDto);
+}

src/main/java/mate/academy/rickandmorty/model/Character.java

@@ -0,0 +1,26 @@
+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.Data;
+
+@Data
+@Entity
+@Table(name = "characters")
+public class Character {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+    @Column(name = "external_id", nullable = false)
+    private String externalId;
+    @Column(nullable = false)
+    private String name;
+    @Column(nullable = false)
+    private String status;
+    @Column(nullable = false)
+    private String gender;
+}

src/main/java/mate/academy/rickandmorty/repository/CharacterRepository.java

@@ -0,0 +1,12 @@
+package mate.academy.rickandmorty.repository;
+
+import java.util.List;
+import mate.academy.rickandmorty.model.Character;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
+
+public interface CharacterRepository extends JpaRepository<Character, Long>,
+        JpaSpecificationExecutor<Character> {
+    List<Character> getCharacterByNameContains(String name, Pageable pageable);
+}

src/main/java/mate/academy/rickandmorty/service/CharacterService.java

@@ -0,0 +1,15 @@
+package mate.academy.rickandmorty.service;
+
+import java.util.List;
+import mate.academy.rickandmorty.dto.internal.CharacterDto;
+import mate.academy.rickandmorty.dto.internal.CharacterSearchParametersDto;
+import org.springframework.data.domain.Pageable;
+
+public interface CharacterService {
+    CharacterDto findByRandomId();
+
+    List<CharacterDto> searchCharactersByName(CharacterSearchParametersDto searchParametersDto,
+                                              Pageable pageable);
+
+    List<CharacterDto> getAll(Pageable pageable);
+}

src/main/java/mate/academy/rickandmorty/service/CharacterServiceImpl.java

@@ -0,0 +1,49 @@
+package mate.academy.rickandmorty.service;
+
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.Random;
+import lombok.RequiredArgsConstructor;
+import mate.academy.rickandmorty.dto.internal.CharacterDto;
+import mate.academy.rickandmorty.dto.internal.CharacterSearchParametersDto;
+import mate.academy.rickandmorty.mapper.CharacterMapper;
+import mate.academy.rickandmorty.repository.CharacterRepository;
+import org.springframework.data.domain.Pageable;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class CharacterServiceImpl implements CharacterService {
+    private static final Long FIRST_ENTITY_ID = 1L;
+    private final CharacterMapper characterMapper;
+    private final CharacterRepository characterRepository;
+
+    @Override
+    public CharacterDto findByRandomId() {
+        long amountOfCharactersInDb = characterRepository.count();
+        long generatedLong = new Random().nextLong(FIRST_ENTITY_ID,
+                amountOfCharactersInDb + 1);
+        return characterMapper.toDto(characterRepository.findById(generatedLong)
+                .orElseThrow(() -> new NoSuchElementException("Can't find a book by id: "
+                        + generatedLong)));
+    }
+
+    @Override
+    public List<CharacterDto> searchCharactersByName(
+            CharacterSearchParametersDto searchParametersDto,
+            Pageable pageable) {
+        String stringForSearch = searchParametersDto.name();
+        return characterRepository.getCharacterByNameContains(stringForSearch, pageable)
+                .stream()
+                .map(characterMapper::toDto)
+                .toList();
+    }
+
+    @Override
+    public List<CharacterDto> getAll(Pageable pageable) {
+        return characterRepository.findAll()
+                .stream()
+                .map(characterMapper::toDto)
+                .toList();
+    }
+}