From dbc4576456b18cf636600b621997008fc9994067 Mon Sep 17 00:00:00 2001 From: johe00123 Date: Sat, 27 Jun 2026 01:21:35 +0900 Subject: [PATCH] =?UTF-8?q?refactor=20:=20Swagger=20@Tag=20=EC=9D=B4?= =?UTF-8?q?=EB=A6=84=20=EC=98=81=EB=AC=B8=EC=9C=BC=EB=A1=9C=20=ED=86=B5?= =?UTF-8?q?=EC=9D=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../com/catchtable/bookmark/controller/BookmarkController.java | 2 +- .../com/catchtable/chatbot/controller/ChatbotController.java | 2 ++ .../java/com/catchtable/coupon/controller/CouponController.java | 2 ++ .../java/com/catchtable/file/controller/FileController.java | 2 +- .../java/com/catchtable/menu/controller/MenuController.java | 2 +- .../notification/controller/NotificationController.java | 2 ++ .../com/catchtable/payment/controller/PaymentController.java | 2 +- .../com/catchtable/remain/controller/StoreRemainController.java | 2 ++ .../reservation/controller/ReservationController.java | 2 +- .../java/com/catchtable/review/controller/ReviewController.java | 2 ++ .../java/com/catchtable/store/controller/StoreController.java | 2 ++ .../java/com/catchtable/user/controller/AuthController.java | 2 +- .../java/com/catchtable/user/controller/UserController.java | 2 +- .../com/catchtable/vacancy/controller/VacancyController.java | 2 ++ 14 files changed, 21 insertions(+), 7 deletions(-) diff --git a/src/main/java/com/catchtable/bookmark/controller/BookmarkController.java b/src/main/java/com/catchtable/bookmark/controller/BookmarkController.java index f5ab1a6..4a86791 100644 --- a/src/main/java/com/catchtable/bookmark/controller/BookmarkController.java +++ b/src/main/java/com/catchtable/bookmark/controller/BookmarkController.java @@ -26,7 +26,7 @@ import java.util.List; -@Tag(name = "북마크", description = "북마크 폴더 및 북마크 관련 API") +@Tag(name = "Bookmark", description = "Bookmark folder and bookmark API") @RestController @RequiredArgsConstructor public class BookmarkController { diff --git a/src/main/java/com/catchtable/chatbot/controller/ChatbotController.java b/src/main/java/com/catchtable/chatbot/controller/ChatbotController.java index eb4e6f0..dbe7455 100644 --- a/src/main/java/com/catchtable/chatbot/controller/ChatbotController.java +++ b/src/main/java/com/catchtable/chatbot/controller/ChatbotController.java @@ -9,12 +9,14 @@ import com.catchtable.global.common.ApiResponse; import com.catchtable.global.common.SuccessCode; import com.catchtable.global.security.CustomUserDetails; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; +@Tag(name = "Chatbot", description = "Chatbot API") @RestController @RequestMapping("/api/v1/chat") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/coupon/controller/CouponController.java b/src/main/java/com/catchtable/coupon/controller/CouponController.java index f4dda42..10711f9 100644 --- a/src/main/java/com/catchtable/coupon/controller/CouponController.java +++ b/src/main/java/com/catchtable/coupon/controller/CouponController.java @@ -9,6 +9,7 @@ import com.catchtable.global.common.ApiResponse; import com.catchtable.global.common.SuccessCode; import com.catchtable.global.security.CustomUserDetails; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.http.CacheControl; @@ -19,6 +20,7 @@ import java.util.List; +@Tag(name = "Coupon", description = "Coupon API") @RestController @RequestMapping("/api/v1/coupons") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/file/controller/FileController.java b/src/main/java/com/catchtable/file/controller/FileController.java index c42aa10..27d46a9 100644 --- a/src/main/java/com/catchtable/file/controller/FileController.java +++ b/src/main/java/com/catchtable/file/controller/FileController.java @@ -18,7 +18,7 @@ import org.springframework.web.bind.annotation.RestController; import org.springframework.web.multipart.MultipartFile; -@Tag(name = "파일 업로드", description = "이미지 등 파일 업로드 API") +@Tag(name = "File", description = "File upload API") @RestController @RequestMapping("/api/v1/files") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/menu/controller/MenuController.java b/src/main/java/com/catchtable/menu/controller/MenuController.java index 161cd21..f3a3c5d 100644 --- a/src/main/java/com/catchtable/menu/controller/MenuController.java +++ b/src/main/java/com/catchtable/menu/controller/MenuController.java @@ -22,7 +22,7 @@ import java.util.List; -@Tag(name = "메뉴 컨트롤러", description = "가게 메뉴 관련 API") +@Tag(name = "Menu", description = "Store menu API") @RestController @RequestMapping("/api/v1/stores/{storeId}/menu") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/notification/controller/NotificationController.java b/src/main/java/com/catchtable/notification/controller/NotificationController.java index 4730775..8c23ec4 100644 --- a/src/main/java/com/catchtable/notification/controller/NotificationController.java +++ b/src/main/java/com/catchtable/notification/controller/NotificationController.java @@ -5,6 +5,7 @@ import com.catchtable.global.security.CustomUserDetails; import com.catchtable.notification.dto.read.NotificationListResponse; import com.catchtable.notification.service.NotificationService; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springdoc.core.annotations.ParameterObject; import org.springframework.data.domain.Page; @@ -15,6 +16,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; +@Tag(name = "Notification", description = "Notification API") @RestController @RequestMapping("/api/v1/notifications") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/payment/controller/PaymentController.java b/src/main/java/com/catchtable/payment/controller/PaymentController.java index 5afbb15..7499249 100644 --- a/src/main/java/com/catchtable/payment/controller/PaymentController.java +++ b/src/main/java/com/catchtable/payment/controller/PaymentController.java @@ -18,7 +18,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "결제", description = "결제 확인 및 검증 API") +@Tag(name = "Payment", description = "Payment confirmation and validation API") @RestController @RequestMapping("/api/v1/payments") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/remain/controller/StoreRemainController.java b/src/main/java/com/catchtable/remain/controller/StoreRemainController.java index 46f3f77..77e36c6 100644 --- a/src/main/java/com/catchtable/remain/controller/StoreRemainController.java +++ b/src/main/java/com/catchtable/remain/controller/StoreRemainController.java @@ -5,6 +5,7 @@ import com.catchtable.remain.dto.read.StoreRemainResponseDto; import com.catchtable.remain.dto.create.StoreRemainCreateRequestDto; import com.catchtable.remain.service.StoreRemainService; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.format.annotation.DateTimeFormat; @@ -14,6 +15,7 @@ import java.time.LocalDate; import java.util.List; +@Tag(name = "Store Remain", description = "Store remaining capacity API") @RestController @RequestMapping("/api/v1/remains") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/reservation/controller/ReservationController.java b/src/main/java/com/catchtable/reservation/controller/ReservationController.java index 8241fe9..5c45484 100644 --- a/src/main/java/com/catchtable/reservation/controller/ReservationController.java +++ b/src/main/java/com/catchtable/reservation/controller/ReservationController.java @@ -23,7 +23,7 @@ import java.util.List; -@Tag(name = "예약", description = "예약 생성 / 조회 / 변경 / 취소 API") +@Tag(name = "Reservation", description = "Reservation create / read / update / cancel API") @RestController @RequestMapping("/api/v1/reservations") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/review/controller/ReviewController.java b/src/main/java/com/catchtable/review/controller/ReviewController.java index 8edff59..271ce1a 100644 --- a/src/main/java/com/catchtable/review/controller/ReviewController.java +++ b/src/main/java/com/catchtable/review/controller/ReviewController.java @@ -7,6 +7,7 @@ import com.catchtable.review.dto.read.ReviewResponseDto; import com.catchtable.review.dto.update.ReviewUpdateRequestDto; import com.catchtable.review.service.ReviewService; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; @@ -15,6 +16,7 @@ import java.util.List; +@Tag(name = "Review", description = "Review API") @RestController @RequestMapping("/api/v1/reviews") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/store/controller/StoreController.java b/src/main/java/com/catchtable/store/controller/StoreController.java index bb600dc..ee54dce 100644 --- a/src/main/java/com/catchtable/store/controller/StoreController.java +++ b/src/main/java/com/catchtable/store/controller/StoreController.java @@ -15,6 +15,7 @@ import com.catchtable.store.entity.District; import com.catchtable.store.service.StoreService; +import io.swagger.v3.oas.annotations.tags.Tag; import java.util.List; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; @@ -23,6 +24,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; +@Tag(name = "Store", description = "Store API") @RestController @RequestMapping("/api/v1/stores") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/user/controller/AuthController.java b/src/main/java/com/catchtable/user/controller/AuthController.java index 7836754..43e907d 100644 --- a/src/main/java/com/catchtable/user/controller/AuthController.java +++ b/src/main/java/com/catchtable/user/controller/AuthController.java @@ -18,7 +18,7 @@ import org.springframework.web.bind.annotation.RestController; @Slf4j -@Tag(name = "인증", description = "소셜 로그인 및 토큰 관련 API") +@Tag(name = "Auth", description = "Social login and token API") @RestController @RequestMapping("/api/v1/auth") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/user/controller/UserController.java b/src/main/java/com/catchtable/user/controller/UserController.java index 7149658..54d8242 100644 --- a/src/main/java/com/catchtable/user/controller/UserController.java +++ b/src/main/java/com/catchtable/user/controller/UserController.java @@ -14,7 +14,7 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; -@Tag(name = "사용자 컨트롤러", description = "사용자 관련 API") +@Tag(name = "User", description = "User API") @RestController @RequestMapping("/api/v1/users") @RequiredArgsConstructor diff --git a/src/main/java/com/catchtable/vacancy/controller/VacancyController.java b/src/main/java/com/catchtable/vacancy/controller/VacancyController.java index 3e81ed0..be6522b 100644 --- a/src/main/java/com/catchtable/vacancy/controller/VacancyController.java +++ b/src/main/java/com/catchtable/vacancy/controller/VacancyController.java @@ -7,6 +7,7 @@ import com.catchtable.vacancy.dto.create.VacancyRegisterResponse; import com.catchtable.vacancy.dto.write.VacancyListResponse; import com.catchtable.vacancy.service.VacancyService; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; @@ -15,6 +16,7 @@ import java.util.List; +@Tag(name = "Vacancy", description = "Store vacancy API") @RestController @RequiredArgsConstructor @RequestMapping("/api/v1/vacancy")