[2 - 4단계 방탈출 결제 / 배포] 이든(최승준) 미션 제출합니다.

README.md

@@ -1,3 +1,7 @@
+# ERD
+
+<img width="1183" alt="image" src="https://github.com/woowacourse/spring-roomescape-payment/assets/84304802/6de95d67-f13e-4b18-b2d5-dc0e27bf515a">
+
 # 기능 명세
 
 ## 1단계 - 에약 시 결제 단계 추가
@@ -318,7 +322,7 @@ Content-Type: application/json
 Request
 
 ```
-DELETE /reservations/1?memberId=1
+DELETE /reservations/1
 Cookie: token=hello.example.token
 ```
 

build.gradle

@@ -19,6 +19,8 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
     implementation 'org.springframework.boot:spring-boot-starter-validation'
 
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0'
+
     implementation 'io.jsonwebtoken:jjwt:0.9.1'
     implementation 'javax.xml.bind:jaxb-api:2.3.1'
 

src/main/java/roomescape/config/SwaggerConfig.java

@@ -0,0 +1,40 @@
+package roomescape.config;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import org.springdoc.core.utils.SpringDocUtils;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import roomescape.config.auth.LoginMember;
+
+@Configuration
+public class SwaggerConfig {
+
+    private static final String SECURITY_SCHEME_NAME = "bearerAuth";
+
+    @Bean
+    public OpenAPI openAPI() {
+        SpringDocUtils.getConfig().addAnnotationsToIgnore(LoginMember.class);
+
+        return new OpenAPI()
+                .addSecurityItem(new SecurityRequirement()
+                        .addList(SECURITY_SCHEME_NAME))
+                .components(new Components()
+                        .addSecuritySchemes(SECURITY_SCHEME_NAME, new SecurityScheme()
+                                .name(SECURITY_SCHEME_NAME)
+                                .type(SecurityScheme.Type.HTTP)
+                                .scheme("bearer")
+                                .bearerFormat("JWT")))
+                .info(apiInfo());
+    }
+
+    private Info apiInfo() {
+        return new Info()
+                .title("Room Escape API Docs")
+                .description("방탈출 예약 시스템 서버 REST API 문서")
+                .version("1.0.0");
+    }
+}

src/main/java/roomescape/controller/login/LoginController.java

@@ -1,5 +1,7 @@
 package roomescape.controller.login;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.servlet.http.Cookie;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.validation.Valid;
@@ -19,6 +21,7 @@
 
 import java.net.URI;
 
+@Tag(name = "Login")
 @RestController
 public class LoginController {
     private final LoginService loginService;
@@ -30,6 +33,7 @@ public LoginController(LoginService loginService, AuthCookieHandler authCookieHa
     }
 
     @PostMapping("/login")
+    @Operation(summary = "로그인", description = "회원정보를 통해 로그인을 수행한다.")
     public ResponseEntity<Void> login(@RequestBody @Valid LoginRequest request, HttpServletResponse response) {
         String token = loginService.login(request);
         Cookie cookie = authCookieHandler.createCookie(token);
@@ -39,20 +43,23 @@ public ResponseEntity<Void> login(@RequestBody @Valid LoginRequest request, Http
 
     @RoleAllowed
     @GetMapping("/login/check")
+    @Operation(summary = "[회원] 로그인 검증", description = "JWT 토큰을 통해 로그인 여부를 검사한다.")
     public ResponseEntity<LoginCheckResponse> loginCheck(@LoginMember Member member) {
         LoginCheckResponse response = loginService.loginCheck(member);
         return ResponseEntity.ok().body(response);
     }
 
     @RoleAllowed
     @PostMapping("/logout")
+    @Operation(summary = "[회원] 로그아웃", description = "로그아웃을 수행한다.")
     public ResponseEntity<Void> logout(HttpServletResponse response) {
         Cookie cookie = authCookieHandler.deleteCookie();
         response.addCookie(cookie);
         return ResponseEntity.ok().build();
     }
 
     @PostMapping("/signup")
+    @Operation(summary = "회원가입", description = "회원가입을 수행한다.")
     public ResponseEntity<SignupResponse> signup(@RequestBody @Valid SignupRequest request) {
         SignupResponse response = loginService.signup(request);
         return ResponseEntity.created(URI.create("/members/" + response.getId())).body(response);

src/main/java/roomescape/controller/member/MemberController.java

@@ -1,5 +1,7 @@
 package roomescape.controller.member;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -8,6 +10,7 @@
 import roomescape.service.member.MemberService;
 import roomescape.service.member.dto.MemberListResponse;
 
+@Tag(name = "Member")
 @RestController
 public class MemberController {
     private final MemberService memberService;
@@ -18,6 +21,7 @@ public MemberController(MemberService memberService) {
 
     @RoleAllowed(MemberRole.ADMIN)
     @GetMapping("/members")
+    @Operation(summary = "[관리자] 전체 회원 정보 조회", description = "전체 회원 정보를 조회한다.")
     public ResponseEntity<MemberListResponse> findAllMember() {
         MemberListResponse response = memberService.findAllMember();
         return ResponseEntity.ok().body(response);

src/main/java/roomescape/controller/reservation/ReservationController.java

@@ -1,5 +1,7 @@
 package roomescape.controller.reservation;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotNull;
 import org.springframework.http.ResponseEntity;
@@ -21,13 +23,15 @@
 import roomescape.service.reservation.dto.AdminReservationRequest;
 import roomescape.service.reservation.dto.ReservationListResponse;
 import roomescape.service.reservation.dto.ReservationMineListResponse;
+import roomescape.service.reservation.dto.ReservationPaymentRequest;
 import roomescape.service.reservation.dto.ReservationRequest;
 import roomescape.service.reservation.dto.ReservationResponse;
 import roomescape.service.reservation.dto.ReservationSaveInput;
 
 import java.net.URI;
 import java.time.LocalDate;
 
+@Tag(name = "Reservation")
 @RestController
 @Validated
 public class ReservationController {
@@ -41,6 +45,7 @@ public ReservationController(ReservationService reservationService, MemberServic
 
     @RoleAllowed(MemberRole.ADMIN)
     @GetMapping("/reservations")
+    @Operation(summary = "[관리자] 예약 정보 검색", description = "회원ID, 테마ID, 시작일, 종료일로 예약 정보를 검색한다.")
     public ResponseEntity<ReservationListResponse> searchReservation(
             @RequestParam(required = false) Long memberId,
             @RequestParam(required = false) Long themeId,
@@ -52,13 +57,15 @@ public ResponseEntity<ReservationListResponse> searchReservation(
 
     @RoleAllowed
     @GetMapping("/reservations-mine")
+    @Operation(summary = "[회원] 내 예약 정보 조회", description = "내 예약 정보를 조회한다.")
     public ResponseEntity<ReservationMineListResponse> findMyReservation(@LoginMember Member member) {
         ReservationMineListResponse response = reservationService.findMyReservation(member);
         return ResponseEntity.ok().body(response);
     }
 
     @RoleAllowed
     @PostMapping("/reservations")
+    @Operation(summary = "[회원] 예약 추가", description = "결제 및 예약을 수행한다.")
     public ResponseEntity<ReservationResponse> saveReservation(@RequestBody @Valid ReservationRequest request,
                                                                @LoginMember Member member) {
         ReservationSaveInput reservationSaveInput = request.toReservationSaveInput();
@@ -69,22 +76,47 @@ public ResponseEntity<ReservationResponse> saveReservation(@RequestBody @Valid R
         return ResponseEntity.created(URI.create("/reservations/" + response.getId())).body(response);
     }
 
+    @RoleAllowed
+    @PostMapping("/reservations/{reservationId}/payment")
+    @Operation(summary = "[회원] 예약 결제", description = "결제 대기 상태의 예약을 결제한다.")
+    public ResponseEntity<ReservationResponse> payReservation(@PathVariable Long reservationId,
+                                                              @RequestBody @Valid ReservationPaymentRequest request,
+                                                              @LoginMember Member member) {
+        PaymentConfirmInput paymentConfirmInput = request.toPaymentConfirmInput();
+
+        ReservationResponse response = reservationService.payReservation(
+                reservationId, paymentConfirmInput, member);
+        return ResponseEntity.ok(response);
+    }
+
     @RoleAllowed(MemberRole.ADMIN)
     @PostMapping("/admin/reservations")
+    @Operation(summary = "[관리자] 예약 추가", description = "결제 없이 예약을 수행한다.")
     public ResponseEntity<ReservationResponse> saveAdminReservation(@RequestBody @Valid AdminReservationRequest request) {
-        ReservationSaveInput reservationSaveInput = request.toReservationSaveInput();
         Member member = memberService.findById(request.getMemberId());
 
+        ReservationSaveInput reservationSaveInput = request.toReservationSaveInput();
         ReservationResponse response = reservationService.saveReservationWithoutPayment(reservationSaveInput, member);
         return ResponseEntity.created(URI.create("/reservations/" + response.getId())).body(response);
     }
 
-    @RoleAllowed(MemberRole.ADMIN)
+    @RoleAllowed
+    @DeleteMapping("/reservations/{reservationId}/cancel")
+    @Operation(summary = "[회원] 예약 취소", description = "예약을 취소하고 결제 금액을 환불한다.")
+    public ResponseEntity<Void> cancelReservation(
+            @PathVariable @NotNull(message = "reservationId 값이 null일 수 없습니다.") Long reservationId,
+            @LoginMember Member member) {
+        reservationService.cancelReservation(reservationId, member);
+        return ResponseEntity.noContent().build();
+    }
+
+    @RoleAllowed
     @DeleteMapping("/reservations/{reservationId}")
+    @Operation(summary = "[회원] 예약 삭제", description = "취소 또는 결제 대기 상태의 예약 정보를 삭제한다.")
     public ResponseEntity<Void> deleteReservation(
             @PathVariable @NotNull(message = "reservationId 값이 null일 수 없습니다.") Long reservationId,
-            @RequestParam @NotNull(message = "memberId 값이 null일 수 없습니다.") Long memberId) {
-        reservationService.deleteReservation(reservationId, memberId);
+            @LoginMember Member member) {
+        reservationService.deleteReservation(reservationId, member);
         return ResponseEntity.noContent().build();
     }
 }

src/main/java/roomescape/controller/reservationtime/ReservationTimeController.java

@@ -1,5 +1,7 @@
 package roomescape.controller.reservationtime;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotNull;
 import org.springframework.http.ResponseEntity;
@@ -22,6 +24,7 @@
 import java.net.URI;
 import java.time.LocalDate;
 
+@Tag(name = "Reservation Time")
 @RestController
 @Validated
 public class ReservationTimeController {
@@ -33,12 +36,14 @@ public ReservationTimeController(ReservationTimeService reservationTimeService)
 
     @RoleAllowed(MemberRole.ADMIN)
     @GetMapping("/times")
+    @Operation(summary = "[관리자] 전체 예약 가능 시간 조회", description = "전체 예약 가능 시간 정보를 조회한다.")
     public ResponseEntity<ReservationTimeListResponse> findAllReservationTime() {
         ReservationTimeListResponse response = reservationTimeService.findAllReservationTime();
         return ResponseEntity.ok().body(response);
     }
 
     @GetMapping("/times/available")
+    @Operation(summary = "날짜/테마의 예약 가능 시간 조회", description = "특정 날짜/테마의 예약 가능한 시간 정보를 조회한다.")
     public ResponseEntity<ReservationTimeAvailableListResponse> findAllAvailableReservationTime(
             @RequestParam LocalDate date, @RequestParam Long themeId) {
         ReservationTimeAvailableListResponse response =
@@ -48,6 +53,7 @@ public ResponseEntity<ReservationTimeAvailableListResponse> findAllAvailableRese
 
     @RoleAllowed(MemberRole.ADMIN)
     @PostMapping("/times")
+    @Operation(summary = "[관리자] 예약 가능 시간 추가", description = "예약 가능 시간을 추가한다.")
     public ResponseEntity<ReservationTimeResponse> saveReservationTime(
             @RequestBody @Valid ReservationTimeRequest request) {
         ReservationTimeResponse response = reservationTimeService.saveReservationTime(request);
@@ -56,6 +62,7 @@ public ResponseEntity<ReservationTimeResponse> saveReservationTime(
 
     @RoleAllowed(MemberRole.ADMIN)
     @DeleteMapping("/times/{timeId}")
+    @Operation(summary = "[관리자] 예약 가능 시간 삭제", description = "예약 가능 시간을 삭제한다.")
     public ResponseEntity<Void> deleteReservationTime(
             @PathVariable @NotNull(message = "timeId 값이 null일 수 없습니다.") Long timeId) {
         reservationTimeService.deleteReservationTime(timeId);

src/main/java/roomescape/controller/reservationwaiting/ReservationWaitingController.java

@@ -1,5 +1,7 @@
 package roomescape.controller.reservationwaiting;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.constraints.NotNull;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.DeleteMapping;
@@ -19,6 +21,7 @@
 
 import java.net.URI;
 
+@Tag(name = "Reservation Waiting")
 @RestController
 public class ReservationWaitingController {
     private final ReservationWaitingService reservationWaitingService;
@@ -29,13 +32,15 @@ public ReservationWaitingController(ReservationWaitingService reservationWaiting
 
     @RoleAllowed(MemberRole.ADMIN)
     @GetMapping("/reservations/waitings")
+    @Operation(summary = "[관리자] 전체 예약 대기 정보 조회", description = "모든 예약 대기 정보를 조회한다.")
     public ResponseEntity<ReservationWaitingListResponse> findAllReservationWaiting() {
         ReservationWaitingListResponse response = reservationWaitingService.findAllReservationWaiting();
         return ResponseEntity.ok().body(response);
     }
 
     @RoleAllowed
     @PostMapping("/reservations/waitings")
+    @Operation(summary = "[회원] 예약 대기 추가", description = "예약 대기를 수행한다.")
     public ResponseEntity<ReservationWaitingResponse> saveReservationWaiting(
             @RequestBody ReservationWaitingRequest request, @LoginMember Member member) {
         ReservationWaitingResponse response = reservationWaitingService.saveReservationWaiting(request, member);
@@ -44,6 +49,7 @@ public ResponseEntity<ReservationWaitingResponse> saveReservationWaiting(
 
     @RoleAllowed
     @DeleteMapping("/reservations/{reservationId}/waitings")
+    @Operation(summary = "[회원] 예약 대기 삭제", description = "자신의 예약 대기를 삭제한다.")
     public ResponseEntity<Void> deleteReservation(
             @PathVariable @NotNull(message = "reservationId 값이 null일 수 없습니다.") Long reservationId,
             @LoginMember Member member) {
@@ -53,6 +59,7 @@ public ResponseEntity<Void> deleteReservation(
 
     @RoleAllowed(MemberRole.ADMIN)
     @DeleteMapping("/admin/reservations/waitings/{waitingId}")
+    @Operation(summary = "[관리자] 예약 대기 삭제", description = "예약 대기를 삭제한다.")
     public ResponseEntity<Void> deleteAdminReservation(
             @PathVariable @NotNull(message = "waitingId 값이 null일 수 없습니다.") Long waitingId) {
         reservationWaitingService.deleteAdminReservationWaiting(waitingId);

src/main/java/roomescape/controller/theme/ThemeController.java

@@ -1,5 +1,7 @@
 package roomescape.controller.theme;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotNull;
 import org.springframework.http.ResponseEntity;
@@ -18,6 +20,7 @@
 
 import java.net.URI;
 
+@Tag(name = "Theme")
 @RestController
 public class ThemeController {
     private final ThemeService themeService;
@@ -27,26 +30,30 @@ public ThemeController(ThemeService themeService) {
     }
 
     @GetMapping("/themes")
+    @Operation(summary = "전체 테마 조회", description = "전체 테마 정보를 조회한다.")
     public ResponseEntity<ThemeListResponse> findAllTheme() {
         ThemeListResponse response = themeService.findAllTheme();
         return ResponseEntity.ok().body(response);
     }
 
     @GetMapping("/themes/popular")
+    @Operation(summary = "인기 테마 조회", description = "TOP10 인기 테마를 조회한다.")
     public ResponseEntity<ThemeListResponse> findAllPopularTheme() {
         ThemeListResponse response = themeService.findAllPopularTheme();
         return ResponseEntity.ok().body(response);
     }
 
     @RoleAllowed(MemberRole.ADMIN)
     @PostMapping("/themes")
+    @Operation(summary = "[관리자] 테마 추가", description = "테마를 추가한다.")
     public ResponseEntity<ThemeResponse> saveTheme(@RequestBody @Valid ThemeRequest request) {
         ThemeResponse response = themeService.saveTheme(request);
         return ResponseEntity.created(URI.create("/themes/" + response.getId())).body(response);
     }
 
     @RoleAllowed(MemberRole.ADMIN)
     @DeleteMapping("/themes/{themeId}")
+    @Operation(summary = "[관리자] 테마 삭제", description = "테마를 삭제한다.")
     public ResponseEntity<Void> deleteTheme(
             @PathVariable @NotNull(message = "themeId 값이 null일 수 없습니다.") Long themeId) {
         themeService.deleteTheme(themeId);