feat: Swagger에 페이지네이션 관련 설명 추가

Covigator · Sep 13, 2024 · ded6dde · ded6dde
1 parent 44cca5b
commit ded6dde
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/src/main/java/com/ku/covigator/controller/CourseController.java b/src/main/java/com/ku/covigator/controller/CourseController.java
@@ -6,11 +6,13 @@
 import com.ku.covigator.security.jwt.LoggedInMemberId;
 import com.ku.covigator.service.CourseService;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
-import org.springframework.data.web.PageableDefault;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
@@ -31,9 +33,16 @@ public ResponseEntity<Void> addCommunityCourse(@LoggedInMemberId Long memberId,
     @Operation(summary = "전체 코스 조회")
     @GetMapping("/community/courses")
     public ResponseEntity<GetCourseListResponse> getAllCommunityCourses(
-            @PageableDefault(
-                    page = 0, size = 10, sort = "createdAt", direction = Sort.Direction.DESC
-            ) Pageable pageable) {
+            @Parameter(description = "페이지 번호 (0부터 시작)", schema = @Schema(defaultValue = "0"))
+            @RequestParam(value = "page", defaultValue = "0") int page,
+
+            @Parameter(description = "페이지 당 항목 수", schema = @Schema(defaultValue = "10"))
+            @RequestParam(value = "size", defaultValue = "10") int size,
+
+            @Parameter(description = "정렬 기준 (리뷰순: reviewCnt), (좋아요순: likeCnt)", schema = @Schema(defaultValue = "createdAt"))
+            @RequestParam(value = "sort", defaultValue = "createdAt") String sort) {
+
+        Pageable pageable = PageRequest.of(page, size, Sort.by(sort).descending());
         return ResponseEntity.ok(courseService.findAllCourses(pageable));
     }
 

diff --git a/src/main/java/com/ku/covigator/controller/ReviewController.java b/src/main/java/com/ku/covigator/controller/ReviewController.java
@@ -5,6 +5,7 @@
 import com.ku.covigator.security.jwt.LoggedInMemberId;
 import com.ku.covigator.service.ReviewService;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Pageable;
@@ -34,6 +35,7 @@ public ResponseEntity<Void> addReview(
     @Operation(summary = "리뷰 조회")
     @GetMapping
     public ResponseEntity<GetReviewResponse> findReviews(
+            @Parameter(hidden = true)
             @PageableDefault(
                     page = 0, size = 10, sort = "createdAt", direction = Sort.Direction.DESC
             ) Pageable pageable,