feat: Swaager summary

src/main/kotlin/com/wafflestudio/interpark/performance/controller/PerformanceController.kt

@@ -32,6 +32,10 @@ class PerformanceController(
     }
 
     @GetMapping("/api/v2/performance/search")
+    @Operation(
+        summary = "페이지네이션이 적용된 공연 조회",
+        description = "제목과 카테고리에 해당하는 공연들의 리스트를 반환합니다."
+    )
     fun searchCursorPerformance(
         @RequestParam title: String?,
         @RequestParam category: PerformanceCategory?,
@@ -47,6 +51,10 @@ class PerformanceController(
     // WARN: THIS IS FOR ADMIN.
     // TODO: SEPERATE THIS TO OTHER APPLICATION
     @PostMapping("/admin/v1/performance")
+    @Operation(
+        summary = "공연 생성",
+        description = "관리자가 공연을 생성할 수 있습니다."
+    )
     fun createPerformance(
         @Valid @RequestBody request: CreatePerformanceRequest,
         @AuthenticationPrincipal userDetails: UserDetailsImpl,
@@ -76,6 +84,10 @@ class PerformanceController(
     }
 
     @DeleteMapping("/admin/v1/performance/{performanceId}")
+    @Operation(
+        summary = "공연 삭제",
+        description = "관리자가 공연을 삭제할 수 있습니다."
+    )
     fun deletePerformance(
         @PathVariable performanceId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl,

src/main/kotlin/com/wafflestudio/interpark/performance/controller/PerformanceEventController.kt

@@ -2,6 +2,7 @@ package com.wafflestudio.interpark.performance.controller
 
 import com.wafflestudio.interpark.performance.service.PerformanceEventService
 import com.wafflestudio.interpark.user.controller.UserDetailsImpl
+import io.swagger.v3.oas.annotations.Operation
 import org.springframework.http.HttpStatus
 import org.springframework.http.ResponseEntity
 import org.springframework.security.core.annotation.AuthenticationPrincipal
@@ -14,6 +15,9 @@ class PerformanceEventController(
     private val performanceEventService: PerformanceEventService,
 ) {
     @GetMapping("/api/v1/performance-event")
+    @Operation(
+        summary = "전체 공연이벤트 조회",
+    )
     fun getPerformanceEvent(
     ): ResponseEntity<GetPerformanceEventResponse> {
         // Currently, no search
@@ -23,6 +27,10 @@ class PerformanceEventController(
     }
 
     @GetMapping("/api/v1/performance-event/{performanceId}/{performanceDate}")
+    @Operation(
+        summary = "특정 공연의 공연이벤트 조회",
+        description = "공연와 특정 공연일이 주어졌을 때 실제 이루어지는 공연들의 정보를 반환합니다."
+    )
     fun getPerformanceEventFromDate(
         @PathVariable performanceId: String,
         @PathVariable performanceDate: String,
@@ -38,6 +46,9 @@ class PerformanceEventController(
     // WARN: THIS IS FOR ADMIN.
     // TODO: SEPERATE THIS TO OTHER APPLICATION
     @PostMapping("/admin/v1/performance-event")
+    @Operation(
+        summary = "공연이벤트 생성",
+    )
     fun createPerformanceEvent(
         @RequestBody request: CreatePerformanceEventRequest,
         @AuthenticationPrincipal userDetails: UserDetailsImpl,
@@ -54,6 +65,9 @@ class PerformanceEventController(
     }
 
     @DeleteMapping("/admin/v1/performance-event/{performanceEventId}")
+    @Operation(
+        summary = "공연이벤트 삭제",
+    )
     fun deletePerformanceEvent(
         @PathVariable performanceEventId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl,

src/main/kotlin/com/wafflestudio/interpark/performance/controller/PerformanceHallController.kt

@@ -2,6 +2,7 @@ package com.wafflestudio.interpark.performance.controller
 
 import com.wafflestudio.interpark.performance.service.PerformanceHallService
 import com.wafflestudio.interpark.user.controller.UserDetailsImpl
+import io.swagger.v3.oas.annotations.Operation
 import org.springframework.http.HttpStatus
 import org.springframework.http.ResponseEntity
 import org.springframework.security.core.annotation.AuthenticationPrincipal
@@ -12,6 +13,9 @@ class PerformanceHallController(
     private val performanceHallService: PerformanceHallService,
 ) {
     @GetMapping("/api/v1/performance-hall")
+    @Operation(
+        summary = "전체 공연장 조회",
+    )
     fun getPerformanceHall(
     ): ResponseEntity<GetPerformanceHallResponse> {
         // Currently, no search
@@ -23,6 +27,9 @@ class PerformanceHallController(
     // WARN: THIS IS FOR ADMIN.
     // TODO: SEPERATE THIS TO OTHER APPLICATION
     @PostMapping("/admin/v1/performance-hall")
+    @Operation(
+        summary = "공연장 생성",
+    )
     fun createPerformanceHall(
         @RequestBody request: CreatePerformanceHallRequest,
         @AuthenticationPrincipal userDetails: UserDetailsImpl,
@@ -38,6 +45,9 @@ class PerformanceHallController(
     }
 
     @DeleteMapping("/admin/v1/performance-hall/{performanceHallId}")
+    @Operation(
+        summary = "공연장 삭제",
+    )
     fun deletePerformance(
         @PathVariable performanceHallId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl,

src/main/kotlin/com/wafflestudio/interpark/review/controller/ReplyController.kt

@@ -4,6 +4,7 @@ import com.wafflestudio.interpark.pagination.CursorPageResponse
 import com.wafflestudio.interpark.pagination.CursorPageable
 import com.wafflestudio.interpark.review.service.ReplyService
 import com.wafflestudio.interpark.user.controller.UserDetailsImpl
+import io.swagger.v3.oas.annotations.Operation
 import org.springframework.http.ResponseEntity
 import org.springframework.security.core.annotation.AuthenticationPrincipal
 import org.springframework.web.bind.annotation.*
@@ -13,6 +14,10 @@ class ReplyController(
     private val replyService: ReplyService,
 ) {
     @GetMapping("/api/v1/me/reply")
+    @Operation(
+        summary = "본인의 댓글 조회",
+        description = "본인이 작성한 댓글들을 조회할 수 있습니다."
+    )
     fun getRepliesByUser(
         @AuthenticationPrincipal userDetails: UserDetailsImpl
     ): ResponseEntity<GetReplyResponse>{
@@ -21,6 +26,10 @@ class ReplyController(
     }
 
     @GetMapping("/api/v1/review/{reviewId}/reply")
+    @Operation(
+        summary = "리뷰의 댓글 조회",
+        description = "특정 리뷰에 달린 댓글들을 조회할 수 있습니다."
+    )
     fun getReplies(
         @PathVariable reviewId: String,
     ): ResponseEntity<GetReplyResponse>{
@@ -29,6 +38,10 @@ class ReplyController(
     }
 
     @GetMapping("/api/v2/review/{reviewId}/reply")
+    @Operation(
+        summary = "페이지네이션이 적용된 리뷰의 댓글 조회",
+        description = "특정 리뷰에 달린 댓글들을 조회할 수 있습니다."
+    )
     fun getCursorReplies(
         @PathVariable reviewId: String,
         @RequestParam cursor: String?,
@@ -39,6 +52,9 @@ class ReplyController(
     }
 
     @PostMapping("/api/v1/review/{reviewId}/reply")
+    @Operation(
+        summary = "댓글 작성",
+    )
     fun createReply(
         @RequestBody request: CreateReplyRequest,
         @PathVariable reviewId: String,
@@ -49,6 +65,9 @@ class ReplyController(
     }
 
     @PutMapping("/api/v1/reply/{replyId}")
+    @Operation(
+        summary = "댓글 수정",
+    )
     fun editReply(
         @RequestBody request: EditReplyRequest,
         @PathVariable replyId: String,
@@ -59,6 +78,9 @@ class ReplyController(
     }
 
     @DeleteMapping("/api/v1/reply/{replyId}")
+    @Operation(
+        summary = "댓글 삭제",
+    )
     fun deleteReply(
         @PathVariable replyId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl

src/main/kotlin/com/wafflestudio/interpark/review/controller/ReviewController.kt

@@ -6,6 +6,7 @@ import com.wafflestudio.interpark.review.*
 import com.wafflestudio.interpark.review.service.ReplyService
 import com.wafflestudio.interpark.review.service.ReviewService
 import com.wafflestudio.interpark.user.controller.UserDetailsImpl
+import io.swagger.v3.oas.annotations.Operation
 import org.springframework.http.ResponseEntity
 import org.springframework.security.core.annotation.AuthenticationPrincipal
 import org.springframework.web.bind.annotation.*
@@ -16,6 +17,10 @@ class ReviewController(
 ) {
 
     @GetMapping("/api/v1/me/review")
+    @Operation(
+        summary = "작성한 리뷰 조회",
+        description = "본인이 작성했던 리뷰들을 조회할 수 있습니다."
+    )
     fun getMyReviews(
         @AuthenticationPrincipal userDetails: UserDetailsImpl
     ): ResponseEntity<GetReviewResponse>{
@@ -24,6 +29,10 @@ class ReviewController(
     }
 
     @GetMapping("/api/v1/performance/{performanceId}/review")
+    @Operation(
+        summary = "공연의 리뷰 조회",
+        description = "특정 공연에 달린 리뷰들을 조회할 수 있습니다."
+    )
     fun getReviews(
         @PathVariable performanceId: String,
     ): ResponseEntity<GetReviewResponse>{
@@ -32,6 +41,10 @@ class ReviewController(
     }
 
     @GetMapping("/api/v2/performance/{performanceId}/review")
+    @Operation(
+        summary = "페이지네이션이 적용된 공연의 리뷰 조회",
+        description = "특정 공연에 달린 리뷰들을 조회할 수 있습니다."
+    )
     fun getCursorReviews(
         @PathVariable performanceId: String,
         @RequestParam cursor: String?,
@@ -42,6 +55,9 @@ class ReviewController(
     }
 
     @PostMapping("/api/v1/performance/{performanceId}/review")
+    @Operation(
+        summary = "리뷰 작성",
+    )
     fun createReview(
         @RequestBody request: CreateReviewRequest,
         @PathVariable performanceId: String,
@@ -52,6 +68,9 @@ class ReviewController(
     }
 
     @PutMapping("/api/v1/review/{reviewId}")
+    @Operation(
+        summary = "리뷰 수정",
+    )
     fun editReview(
         @RequestBody request: EditReviewRequest,
         @PathVariable reviewId: String,
@@ -62,6 +81,9 @@ class ReviewController(
     }
 
     @DeleteMapping("/api/v1/review/{reviewId}")
+    @Operation(
+        summary = "리뷰 삭제",
+    )
     fun deleteReview(
         @PathVariable reviewId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl
@@ -71,6 +93,9 @@ class ReviewController(
     }
 
     @PostMapping("/api/v1/review/{reviewId}/like")
+    @Operation(
+        summary = "리뷰 공감",
+    )
     fun likeReview(
         @PathVariable reviewId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl
@@ -80,6 +105,9 @@ class ReviewController(
     }
 
     @DeleteMapping("/api/v1/review/{reviewId}/like")
+    @Operation(
+        summary = "리뷰 공감 취소",
+    )
     fun cancelLikeReview(
         @PathVariable reviewId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl

src/main/kotlin/com/wafflestudio/interpark/seat/controller/SeatController.kt

@@ -4,6 +4,7 @@ import com.wafflestudio.interpark.seat.service.SeatService
 import com.wafflestudio.interpark.user.AuthUser
 import com.wafflestudio.interpark.user.controller.User
 import com.wafflestudio.interpark.user.controller.UserDetailsImpl
+import io.swagger.v3.oas.annotations.Operation
 import org.springframework.http.ResponseEntity
 import org.springframework.security.core.annotation.AuthenticationPrincipal
 import org.springframework.web.bind.annotation.DeleteMapping
@@ -19,6 +20,10 @@ class SeatController(
     private val seatService: SeatService,
 ) {
     @GetMapping("/api/v1/seat/{performanceEventId}/available")
+    @Operation(
+        summary = "예매가능한 좌석 조회",
+        description = "구체적인 공연이 주어졌을 때 그 공연에서 예매할 수 있는 좌석들을 알려줍니다."
+    )
     fun getAvailableSeats(
         @PathVariable performanceEventId: String,
     ): ResponseEntity<GetAvailableSeatsResponse> {
@@ -27,6 +32,10 @@ class SeatController(
     }
 
     @PostMapping("/api/v1/reservation/reserve")
+    @Operation(
+        summary = "예매",
+        description = "좌석을 선택해서 예매할 수 있습니다. 예매에 실패하면 409가 반환됩니다."
+    )
     fun reserveSeat(
         @RequestBody request: ReserveSeatRequest,
         @AuthenticationPrincipal userDetails: UserDetailsImpl
@@ -36,6 +45,10 @@ class SeatController(
     }
 
     @GetMapping("/api/v1/me/reservation")
+    @Operation(
+        summary = "본인의 예매내역 조회",
+        description = "본인이 예매한 내역을 예매정보를 간략화 한 배열로 반환합니다.\n더 구체적인 정보가 필요하다면 /api/v1/reservation/detail/{reservationId}를 사용해야 합니다."
+    )
     fun getMyReservations(
         @AuthenticationPrincipal userDetails: UserDetailsImpl
     ): ResponseEntity<GetMyReservationsResponse> {
@@ -44,6 +57,10 @@ class SeatController(
     }
 
     @GetMapping("/api/v1/reservation/detail/{reservationId}")
+    @Operation(
+        summary = "본인의 예매 자세히 보기",
+        description = "본인의 예매 중 하나를 선택해 자세한 정보를 받을 수 있습니다."
+    )
     fun getReservedSeatDetail(
         @PathVariable reservationId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl
@@ -53,6 +70,10 @@ class SeatController(
     }
 
     @DeleteMapping("/api/v1/reservation/{reservationId}")
+    @Operation(
+        summary = "예매 취소",
+        description = "본인의 예매 중 하나를 선택해 취소할 수 있습니다."
+    )
     fun cancelReservedSeat(
         @PathVariable reservationId: String,
         @AuthenticationPrincipal userDetails: UserDetailsImpl