external and intrnl dto strategy for ext and int APIs, swagger documentation

orest40th · orest40th · commit eb314a74d38d · 2025-02-17T19:47:23.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -19,28 +19,55 @@
 		<maven.checkstyle.plugin.configLocation>
 			https://raw.githubusercontent.com/mate-academy/style-guides/master/java/checkstyle.xml
 		</maven.checkstyle.plugin.configLocation>
+		<org.mapstruct.version>1.5.5.Final</org.mapstruct.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>
 			<scope>test</scope>
 		</dependency>
-
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-data-jpa</artifactId>
 		</dependency>
-
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+			<version>2.2.0</version>
+		</dependency>
 		<dependency>
 			<groupId>com.h2database</groupId>
 			<artifactId>h2</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>mysql</groupId>
+			<artifactId>mysql-connector-java</artifactId>
+			<version>8.0.33</version>
+		</dependency>
+		<dependency>
+		<groupId>org.mapstruct</groupId>
+		<artifactId>mapstruct</artifactId>
+		<version>${org.mapstruct.version}</version>
+	</dependency>
+		<dependency>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct-processor</artifactId>
+			<version>${org.mapstruct.version}</version>
+			<scope>provided</scope>
+		</dependency>
 	</dependencies>
 
 	<build>
@@ -66,6 +93,7 @@
 					<consoleOutput>true</consoleOutput>
 					<failsOnError>true</failsOnError>
 					<linkXRef>false</linkXRef>
+					<sourceDirectories>src</sourceDirectories>
 				</configuration>
 			</plugin>
 		</plugins>
diff --git a/src/main/java/mate/academy/rickandmorty/Application.java b/src/main/java/mate/academy/rickandmorty/Application.java
@@ -1,12 +1,25 @@
 package mate.academy.rickandmorty;
 
+import lombok.RequiredArgsConstructor;
+import mate.academy.rickandmorty.service.CharacterService;
+import org.springframework.boot.CommandLineRunner;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
 
 @SpringBootApplication
+@RequiredArgsConstructor
 public class Application {
+    private final CharacterService service;
 
     public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }
+
+    @Bean
+    public CommandLineRunner runDatabaseInitialization() {
+        return args -> {
+            service.initializeDatabase();
+        };
+    }
 }
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/RAndMUniverseController.java b/src/main/java/mate/academy/rickandmorty/controller/RAndMUniverseController.java
@@ -0,0 +1,37 @@
+package mate.academy.rickandmorty.controller;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import mate.academy.rickandmorty.dto.CharacterDto;
+import mate.academy.rickandmorty.service.CharacterService;
+import org.springframework.data.domain.Page;
+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.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@Tag(name = "Rick&Morty universe management",
+        description = "Endpoints for the universe management")
+@RestController
+@RequestMapping("/rmuniverse")
+@RequiredArgsConstructor
+public class RAndMUniverseController {
+    private final CharacterService service;
+
+    @Operation(summary = "Get a random character",
+            description = "Retrieves a random character from the universe")
+    @GetMapping("char/random")
+    public CharacterDto getRandomChar() {
+        return service.getRandom();
+    }
+
+    @Operation(summary = "Get character by name",
+            description = "Retrieves a character by name from the universe"
+                    + " with sorting and pagination")
+    @GetMapping("char/by-name")
+    public Page<CharacterDto> findCharByName(@RequestParam String name, Pageable pageable) {
+        return service.findByName(name, pageable);
+    }
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dto/CharacterDto.java b/src/main/java/mate/academy/rickandmorty/dto/CharacterDto.java
@@ -0,0 +1,9 @@
+package mate.academy.rickandmorty.dto;
+
+public record CharacterDto(
+        Long id,
+        Long externalId,
+        String name,
+        String status,
+        String gender) {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dtoexternal/CharacterMetadataDto.java b/src/main/java/mate/academy/rickandmorty/dtoexternal/CharacterMetadataDto.java
@@ -0,0 +1,4 @@
+package mate.academy.rickandmorty.dtoexternal;
+
+public record CharacterMetadataDto(int count, int pages, String next, String prev) {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dtoexternal/CharacterRecordDto.java b/src/main/java/mate/academy/rickandmorty/dtoexternal/CharacterRecordDto.java
@@ -0,0 +1,20 @@
+package mate.academy.rickandmorty.dtoexternal;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.time.OffsetDateTime;
+
+public record CharacterRecordDto(
+        @JsonProperty("id")
+        Long externalId,
+        String name,
+        String status,
+        String species,
+        String type,
+        String gender,
+        LocationDto origin,
+        LocationDto location,
+        String image,
+        String[] episode,
+        String url,
+        OffsetDateTime created) {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dtoexternal/CharacterResponseDataDto.java b/src/main/java/mate/academy/rickandmorty/dtoexternal/CharacterResponseDataDto.java
@@ -0,0 +1,8 @@
+package mate.academy.rickandmorty.dtoexternal;
+
+import java.util.List;
+
+public record CharacterResponseDataDto(
+        CharacterMetadataDto info,
+        List<CharacterRecordDto> results) {
+}
diff --git a/src/main/java/mate/academy/rickandmorty/dtoexternal/LocationDto.java b/src/main/java/mate/academy/rickandmorty/dtoexternal/LocationDto.java
@@ -0,0 +1,5 @@
+package mate.academy.rickandmorty.dtoexternal;
+
+public record LocationDto(String name, String url) {
+
+}
diff --git a/src/main/java/mate/academy/rickandmorty/mapper/CharacterMapper.java b/src/main/java/mate/academy/rickandmorty/mapper/CharacterMapper.java
@@ -0,0 +1,14 @@
+package mate.academy.rickandmorty.mapper;
+
+import mate.academy.rickandmorty.config.MapperConfig;
+import mate.academy.rickandmorty.dto.CharacterDto;
+import mate.academy.rickandmorty.dtoexternal.CharacterRecordDto;
+import mate.academy.rickandmorty.model.Character;
+import org.mapstruct.Mapper;
+
+@Mapper(config = MapperConfig.class)
+public interface CharacterMapper {
+    Character toModel(CharacterRecordDto recordDto);
+
+    CharacterDto toDto(Character character);
+}
diff --git a/src/main/java/mate/academy/rickandmorty/model/Character.java b/src/main/java/mate/academy/rickandmorty/model/Character.java
@@ -0,0 +1,32 @@
+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;
+
+@Entity
+@Table(name = "characters")
+@Getter
+@Setter
+public class Character {
+    @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;
+}
diff --git a/src/main/java/mate/academy/rickandmorty/repository/CharacterRepository.java b/src/main/java/mate/academy/rickandmorty/repository/CharacterRepository.java
@@ -0,0 +1,12 @@
+package mate.academy.rickandmorty.repository;
+
+import mate.academy.rickandmorty.model.Character;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface CharacterRepository extends JpaRepository<Character, Long> {
+    Page<Character> findByNameContainingIgnoreCase(String name, Pageable pageable);
+}
diff --git a/src/main/java/mate/academy/rickandmorty/service/CharacterClient.java b/src/main/java/mate/academy/rickandmorty/service/CharacterClient.java
@@ -0,0 +1,8 @@
+package mate.academy.rickandmorty.service;
+
+import java.util.List;
+import mate.academy.rickandmorty.dtoexternal.CharacterResponseDataDto;
+
+public interface CharacterClient {
+    List<CharacterResponseDataDto> initializeDatabase();
+}
diff --git a/src/main/java/mate/academy/rickandmorty/service/CharacterClientImpl.java b/src/main/java/mate/academy/rickandmorty/service/CharacterClientImpl.java
@@ -0,0 +1,48 @@
+package mate.academy.rickandmorty.service;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.io.IOException;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.util.ArrayList;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import mate.academy.rickandmorty.dtoexternal.CharacterResponseDataDto;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class CharacterClientImpl implements CharacterClient {
+    private static final String GET_ALL_CHARS_URL = "https://rickandmortyapi.com/api/character";
+
+    private final ObjectMapper mapper;
+
+    @Override
+    public List<CharacterResponseDataDto> initializeDatabase() {
+        HttpClient client = HttpClient.newHttpClient();
+        HttpRequest request;
+        HttpResponse<String> response;
+
+        try {
+            List<CharacterResponseDataDto> responseDataDtoTotal = new ArrayList<>();
+            CharacterResponseDataDto characterResponseDataDto;
+            String nextPage = GET_ALL_CHARS_URL;
+            do {
+                request = HttpRequest.newBuilder()
+                        .GET()
+                        .uri(URI.create(nextPage))
+                        .build();
+                response = client.send(request, HttpResponse.BodyHandlers.ofString());
+                characterResponseDataDto = mapper.readValue(response.body(),
+                        CharacterResponseDataDto.class);
+                responseDataDtoTotal.add(characterResponseDataDto);
+            } while ((nextPage = characterResponseDataDto.info().next()) != null);
+
+            return responseDataDtoTotal;
+        } catch (IOException | InterruptedException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}
diff --git a/src/main/java/mate/academy/rickandmorty/service/CharacterService.java b/src/main/java/mate/academy/rickandmorty/service/CharacterService.java
@@ -0,0 +1,13 @@
+package mate.academy.rickandmorty.service;
+
+import mate.academy.rickandmorty.dto.CharacterDto;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+
+public interface CharacterService {
+    CharacterDto getRandom();
+
+    Page<CharacterDto> findByName(String name, Pageable pageable);
+
+    void initializeDatabase();
+}
diff --git a/src/main/java/mate/academy/rickandmorty/service/CharacterServiceImpl.java b/src/main/java/mate/academy/rickandmorty/service/CharacterServiceImpl.java
@@ -0,0 +1,53 @@
+package mate.academy.rickandmorty.service;
+
+import jakarta.persistence.EntityNotFoundException;
+import java.util.List;
+import java.util.Random;
+import lombok.RequiredArgsConstructor;
+import mate.academy.rickandmorty.dto.CharacterDto;
+import mate.academy.rickandmorty.dtoexternal.CharacterResponseDataDto;
+import mate.academy.rickandmorty.mapper.CharacterMapper;
+import mate.academy.rickandmorty.model.Character;
+import mate.academy.rickandmorty.repository.CharacterRepository;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class CharacterServiceImpl implements CharacterService {
+    private static final long TOTAL_CHARS = 826;
+
+    private final CharacterClient client;
+
+    private final CharacterMapper mapper;
+
+    private final CharacterRepository repository;
+
+    private final Random random = new Random();
+
+    @Override
+    public Page<CharacterDto> findByName(String name, Pageable pageable) {
+        return repository.findByNameContainingIgnoreCase(name, pageable).map(mapper::toDto);
+    }
+
+    @Override
+    public void initializeDatabase() {
+        client.initializeDatabase().stream()
+                .map(CharacterResponseDataDto::results)
+                .flatMap(List::stream)
+                .map(mapper::toModel)
+                .forEach(repository::save);
+    }
+
+    @Override
+    public CharacterDto getRandom() {
+        Long id = random.nextLong(TOTAL_CHARS) + 1;
+        Character byId = repository
+                .findById(id)
+                .orElseThrow(() -> new EntityNotFoundException(
+                        "Character not found by id: " + id)
+                );
+        return mapper.toDto(byId);
+    }
+}
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -1 +1,8 @@
-
+spring.datasource.url=jdbc:mysql://localhost:3306/rickandmortydb?createDatabaseIfNotExist=true
+spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
+spring.datasource.username=root
+spring.datasource.password=ko4erhin
+spring.jpa.hibernate.ddl-auto=create
+springdoc.api-docs.enabled=true
+springdoc.swagger-ui.enabled=true
+server.servlet.context-path=/api
diff --git a/src/test/java/mate/academy/rickandmorty/ApplicationTests.java b/src/test/java/mate/academy/rickandmorty/ApplicationTests.java

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +package mate.academy.rickandmorty.dtoexternal;
++
 +public record CharacterMetadataDto(int count, int pages, String next, String prev) {
 +}