fix : cursor 응답 스키마 변경 (#174)

YAPP-Github · Sep 20, 2024 · 7addf21 · 7addf21
1 parent f3b343e
commit 7addf21
Show file tree

Hide file tree

Showing 16 changed files with 121 additions and 58 deletions.
diff --git a/app/api/common-api/src/main/java/org/example/dto/response/CursorApiResponse.java b/app/api/common-api/src/main/java/org/example/dto/response/CursorApiResponse.java
@@ -1,6 +1,7 @@
 package org.example.dto.response;
 
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.util.List;
 import java.util.UUID;
 
 public record CursorApiResponse(
@@ -11,12 +12,20 @@ public record CursorApiResponse(
     @Schema(description = "조회한 데이터의 Cursor Value")
     Object value
 ) {
+
     public static CursorApiResponse toCursorResponse(UUID id, Object value) {
         return new CursorApiResponse(id, value);
     }
 
     public static CursorApiResponse toCursorId(UUID id) {
-        return new CursorApiResponse(id, "");
+        return new CursorApiResponse(id, null);
+    }
+
+    public static CursorApiResponse noneCursor() {
+        return new CursorApiResponse(null, null);
     }
 
+    public static <T> T getLastElement(List<T> list) {
+        return list.isEmpty() ? null : list.get(list.size() - 1);
+    }
 }
diff --git a/app/api/common-api/src/main/java/org/example/dto/response/PaginationApiResponse.java b/app/api/common-api/src/main/java/org/example/dto/response/PaginationApiResponse.java
@@ -10,14 +10,17 @@ public record PaginationApiResponse<T>(
     @Schema(description = "다음 조회 가능 여부")
     boolean hasNext,
     @Schema(description = "조회 데이터")
-    List<T> data
+    List<T> data,
+    @Schema(description = "조회 데이터의 cursor")
+    CursorApiResponse cursor
 ) {
 
     @Builder
     public PaginationApiResponse(
         List<T> data,
-        boolean hasNext
+        boolean hasNext,
+        CursorApiResponse cursor
     ) {
-        this(data.size(), hasNext, data);
+        this(data.size(), hasNext, data, cursor);
     }
 }
diff --git a/app/api/show-api/src/main/java/com/example/artist/controller/ArtistController.java b/app/api/show-api/src/main/java/com/example/artist/controller/ArtistController.java
@@ -17,8 +17,10 @@
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
+import java.util.Optional;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
+import org.example.dto.response.CursorApiResponse;
 import org.example.dto.response.PaginationApiResponse;
 import org.example.security.dto.AuthenticatedInfo;
 import org.example.util.ValidatorUser;
@@ -52,10 +54,15 @@ public ResponseEntity<PaginationApiResponse<ArtistUnsubscriptionPaginationApiPar
             .map(ArtistUnsubscriptionPaginationApiParam::from)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<ArtistUnsubscriptionPaginationApiParam>builder()
                 .hasNext(response.hasNext())
                 .data(data)
+                .cursor(cursor)
                 .build()
         );
     }
@@ -73,10 +80,15 @@ public ResponseEntity<PaginationApiResponse<ArtistSubscriptionPaginationApiParam
             .map(ArtistSubscriptionPaginationApiParam::from)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<ArtistSubscriptionPaginationApiParam>builder()
                 .hasNext(response.hasNext())
                 .data(data)
+                .cursor(cursor)
                 .build()
         );
     }
@@ -131,10 +143,15 @@ public ResponseEntity<PaginationApiResponse<ArtistSearchPaginationApiParam>> sea
             .map(ArtistSearchPaginationApiParam::from)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<ArtistSearchPaginationApiParam>builder()
                 .hasNext(response.hasNext())
                 .data(data)
+                .cursor(cursor)
                 .build()
         );
     }

diff --git a/...src/main/java/com/example/artist/controller/dto/param/ArtistSearchPaginationApiParam.java b/...src/main/java/com/example/artist/controller/dto/param/ArtistSearchPaginationApiParam.java
@@ -2,11 +2,11 @@
 
 import com.example.artist.service.dto.param.ArtistSearchPaginationServiceParam;
 import io.swagger.v3.oas.annotations.media.Schema;
-import org.example.dto.response.CursorApiResponse;
+import java.util.UUID;
 
 public record ArtistSearchPaginationApiParam(
-    @Schema(description = "조회한 데이터의 Cursor")
-    CursorApiResponse cursor,
+    @Schema(description = "아티스트 ID")
+    UUID id,
 
     @Schema(description = "아티스트 이미지 URL")
     String imageURL,
@@ -23,7 +23,7 @@ public record ArtistSearchPaginationApiParam(
 
     public static ArtistSearchPaginationApiParam from(ArtistSearchPaginationServiceParam param) {
         return new ArtistSearchPaginationApiParam(
-            CursorApiResponse.toCursorId(param.artistId()),
+            param.artistId(),
             param.artistImageUrl(),
             param.artistKoreanName(),
             param.artistEnglishName(),

diff --git a/...in/java/com/example/artist/controller/dto/param/ArtistSubscriptionPaginationApiParam.java b/...in/java/com/example/artist/controller/dto/param/ArtistSubscriptionPaginationApiParam.java
@@ -2,11 +2,11 @@
 
 import com.example.artist.service.dto.param.ArtistSubscriptionPaginationServiceParam;
 import io.swagger.v3.oas.annotations.media.Schema;
-import org.example.dto.response.CursorApiResponse;
+import java.util.UUID;
 
 public record ArtistSubscriptionPaginationApiParam(
-    @Schema(description = "조회한 데이터의 Cursor")
-    CursorApiResponse cursor,
+    @Schema(description = "아티스트 ID")
+    UUID id,
     @Schema(description = "아티스트 이미지 URL")
     String imageURL,
     @Schema(description = "아티스트 한글 이름")
@@ -15,11 +15,9 @@ public record ArtistSubscriptionPaginationApiParam(
     String englishName
 ) {
 
-    public static ArtistSubscriptionPaginationApiParam from(
-        ArtistSubscriptionPaginationServiceParam param
-    ) {
+    public static ArtistSubscriptionPaginationApiParam from(ArtistSubscriptionPaginationServiceParam param) {
         return new ArtistSubscriptionPaginationApiParam(
-            CursorApiResponse.toCursorId(param.artistId()),
+            param.artistId(),
             param.artistImageUrl(),
             param.artistKoreanName(),
             param.artistEnglishName()

diff --git a/.../java/com/example/artist/controller/dto/param/ArtistUnsubscriptionPaginationApiParam.java b/.../java/com/example/artist/controller/dto/param/ArtistUnsubscriptionPaginationApiParam.java
@@ -2,11 +2,11 @@
 
 import com.example.artist.service.dto.param.ArtistUnsubscriptionPaginationServiceParam;
 import io.swagger.v3.oas.annotations.media.Schema;
-import org.example.dto.response.CursorApiResponse;
+import java.util.UUID;
 
 public record ArtistUnsubscriptionPaginationApiParam(
-    @Schema(description = "조회한 데이터의 Cursor")
-    CursorApiResponse cursor,
+    @Schema(description = "아티스트 ID")
+    UUID id,
     @Schema(description = "아티스트 이미지 URL")
     String imageURL,
     @Schema(description = "아티스트 한글 이름")
@@ -19,7 +19,7 @@ public static ArtistUnsubscriptionPaginationApiParam from(
         ArtistUnsubscriptionPaginationServiceParam param
     ) {
         return new ArtistUnsubscriptionPaginationApiParam(
-            CursorApiResponse.toCursorId(param.artistId()),
+            param.artistId(),
             param.artistImageUrl(),
             param.artistKoreanName(),
             param.artistEnglishName()

diff --git a/app/api/show-api/src/main/java/com/example/genre/controller/GenreController.java b/app/api/show-api/src/main/java/com/example/genre/controller/GenreController.java
@@ -15,8 +15,10 @@
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
+import java.util.Optional;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
+import org.example.dto.response.CursorApiResponse;
 import org.example.dto.response.PaginationApiResponse;
 import org.example.security.dto.AuthenticatedInfo;
 import org.example.util.ValidatorUser;
@@ -49,10 +51,15 @@ public ResponseEntity<PaginationApiResponse<GenrePaginationApiParam>> getGenres(
             .map(GenrePaginationApiParam::new)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<GenrePaginationApiParam>builder()
                 .hasNext(response.hasNext())
                 .data(data)
+                .cursor(cursor)
                 .build()
         );
     }
@@ -70,10 +77,15 @@ public ResponseEntity<PaginationApiResponse<GenreUnsubscriptionPaginationApiPara
             .map(GenreUnsubscriptionPaginationApiParam::new)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<GenreUnsubscriptionPaginationApiParam>builder()
                 .hasNext(response.hasNext())
                 .data(data)
+                .cursor(cursor)
                 .build()
         );
     }
@@ -91,10 +103,15 @@ public ResponseEntity<PaginationApiResponse<GenreSubscriptionPaginationApiParam>
             .map(GenreSubscriptionPaginationApiParam::new)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<GenreSubscriptionPaginationApiParam>builder()
                 .hasNext(response.hasNext())
                 .data(data)
+                .cursor(cursor)
                 .build()
         );
     }

diff --git a/...how-api/src/main/java/com/example/genre/controller/dto/param/GenrePaginationApiParam.java b/...how-api/src/main/java/com/example/genre/controller/dto/param/GenrePaginationApiParam.java
@@ -2,12 +2,12 @@
 
 import com.example.genre.service.dto.param.GenrePaginationServiceParam;
 import io.swagger.v3.oas.annotations.media.Schema;
-import org.example.dto.response.CursorApiResponse;
+import java.util.UUID;
 
 public record GenrePaginationApiParam(
 
-    @Schema(description = "조회한 데이터의 Cursor")
-    CursorApiResponse cursor,
+    @Schema(description = "장르 ID")
+    UUID id,
 
     @Schema(description = "장르 이름")
     String name,
@@ -18,7 +18,7 @@ public record GenrePaginationApiParam(
 
     public GenrePaginationApiParam(GenrePaginationServiceParam param) {
         this(
-            CursorApiResponse.toCursorId(param.id()),
+            param.id(),
             param.name(),
             param.isSubscribed()
         );

diff --git a/...main/java/com/example/genre/controller/dto/param/GenreSubscriptionPaginationApiParam.java b/...main/java/com/example/genre/controller/dto/param/GenreSubscriptionPaginationApiParam.java
@@ -2,11 +2,11 @@
 
 import com.example.genre.service.dto.param.GenreSubscriptionPaginationServiceParam;
 import io.swagger.v3.oas.annotations.media.Schema;
-import org.example.dto.response.CursorApiResponse;
+import java.util.UUID;
 
 public record GenreSubscriptionPaginationApiParam(
-    @Schema(description = "조회한 데이터의 Cursor")
-    CursorApiResponse cursor,
+    @Schema(description = "장르 ID")
+    UUID id,
 
     @Schema(description = "장르 이름")
     String name
@@ -16,7 +16,7 @@ public GenreSubscriptionPaginationApiParam(
         GenreSubscriptionPaginationServiceParam response
     ) {
         this(
-            CursorApiResponse.toCursorId(response.id()),
+            response.id(),
             response.name()
         );
     }

diff --git a/...in/java/com/example/genre/controller/dto/param/GenreUnsubscriptionPaginationApiParam.java b/...in/java/com/example/genre/controller/dto/param/GenreUnsubscriptionPaginationApiParam.java
@@ -2,11 +2,11 @@
 
 import com.example.genre.service.dto.param.GenreUnsubscriptionPaginationServiceParam;
 import io.swagger.v3.oas.annotations.media.Schema;
-import org.example.dto.response.CursorApiResponse;
+import java.util.UUID;
 
 public record GenreUnsubscriptionPaginationApiParam(
-    @Schema(description = "조회한 데이터의 Cursor")
-    CursorApiResponse cursor,
+    @Schema(description = "장르 ID")
+    UUID id,
 
     @Schema(description = "장르 이름")
     String name
@@ -16,7 +16,7 @@ public GenreUnsubscriptionPaginationApiParam(
         GenreUnsubscriptionPaginationServiceParam response
     ) {
         this(
-            CursorApiResponse.toCursorId(response.id()),
+            response.id(),
             response.name()
         );
     }

diff --git a/app/api/show-api/src/main/java/com/example/show/controller/ShowController.java b/app/api/show-api/src/main/java/com/example/show/controller/ShowController.java
@@ -9,8 +9,10 @@
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
+import java.util.Optional;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
+import org.example.dto.response.CursorApiResponse;
 import org.example.dto.response.PaginationApiResponse;
 import org.example.security.dto.AuthenticatedInfo;
 import org.example.util.ValidatorUser;
@@ -41,10 +43,15 @@ public ResponseEntity<PaginationApiResponse<ShowPaginationApiParam>> getShows(
             .map(ShowPaginationApiParam::from)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<ShowPaginationApiParam>builder()
                 .data(data)
                 .hasNext(response.hasNext())
+                .cursor(cursor)
                 .build()
         );
     }
@@ -69,15 +76,19 @@ public ResponseEntity<PaginationApiResponse<ShowSearchPaginationApiParam>> searc
         @Valid @ParameterObject ShowSearchPaginationApiRequest request
     ) {
         var response = showService.searchShow(request.toServiceRequest());
-
         var data = response.data().stream()
             .map(ShowSearchPaginationApiParam::from)
             .toList();
 
+        CursorApiResponse cursor = Optional.ofNullable(CursorApiResponse.getLastElement(data))
+            .map(element -> CursorApiResponse.toCursorId(element.id()))
+            .orElse(CursorApiResponse.noneCursor());
+
         return ResponseEntity.ok(
             PaginationApiResponse.<ShowSearchPaginationApiParam>builder()
                 .hasNext(response.hasNext())
                 .data(data)
+                .cursor(cursor)
                 .build()
         );
     }