From 940b1f5c2ea3104cdfdb3b502701e34364c32957 Mon Sep 17 00:00:00 2001
From: jeongyun1206 <67818407+jeongyun1206@users.noreply.github.com>
Date: Mon, 13 Jan 2025 17:03:11 +0900
Subject: [PATCH] =?UTF-8?q?#322=20docs:=20=ED=8E=98=EC=9D=B4=EC=A7=95=20?=
=?UTF-8?q?=EA=B4=80=EB=A0=A8=20swagger=20=EC=84=A4=EB=AA=85=20=EC=B6=94?=
=?UTF-8?q?=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../drinkeg/domain/wine/controller/WineController.java | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/src/main/java/com/drinkeg/drinkeg/domain/wine/controller/WineController.java b/src/main/java/com/drinkeg/drinkeg/domain/wine/controller/WineController.java
index 3b289d7d..c7861810 100644
--- a/src/main/java/com/drinkeg/drinkeg/domain/wine/controller/WineController.java
+++ b/src/main/java/com/drinkeg/drinkeg/domain/wine/controller/WineController.java
@@ -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) {
@@ -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,