Skip to content

Commit

Permalink
#322 docs: 페이징 관련 swagger 설명 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
jeongyun1206 committed Jan 13, 2025
1 parent 4171dfb commit 940b1f5
Showing 1 changed file with 5 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ public class WineController {
private final WineService wineService;

@GetMapping
@Operation(summary = "와인 검색", description = "와인 이름 또는 영어 이름으로 검색하여 와인의 기본 정보를 조회한다.")
@Operation(summary = "와인 검색", description = "와인 이름 또는 영어 이름으로 검색하여 와인의 기본 정보를 조회한다. " +
"paging 기능의 sort는 디폴트 값(name)을 사용하는 것을 권장한다.")
public ApiResponse<List<WinePreviewResponse>> searchWine(
@RequestParam(defaultValue = "") String searchName,
@ParameterObject @PageableDefault(size = 10, sort = "name") Pageable pageable) {
Expand All @@ -56,8 +57,9 @@ public ApiResponse<WineWithThreeReviewsResponse> findWineById(

// todo: 페이징 구현하기
@GetMapping("/review/{wineId}")
@Operation(summary = "와인 리뷰 전체 조회", description = "선택한 와인의 리뷰들을 List에 담아서 반환한다." +
" 정렬 기준(sortType)은 \"최신순\", \"오래된 순\",\" 별점 높은 순\", \"별점 낮은 순\"으로 설정할 수 있다.")
@Operation(summary = "와인 리뷰 전체 조회", description = "선택한 와인의 리뷰들을 List에 담아서 반환한다. " +
" 정렬 기준(sortType)은 \"최신순\", \"오래된 순\",\" 별점 높은 순\", \"별점 낮은 순\"으로 설정할 수 있다. "
+"paging 기능의 sort는 사용하지 않고 sortType을 사용한다.")
public ApiResponse<List<WineReviewResponse>> showWineReview(
@PathVariable("wineId") Long wineId,
@RequestParam String sortType,
Expand Down

0 comments on commit 940b1f5

Please sign in to comment.