pricelees/roomescape-refactored
1
0
Fork 0
generated from pricelees/issue-pr-template
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: API / 에러 응답 객체 이름 형식 통일 (-> RoomescapeXxxResponse)

Browse Source
This commit is contained in:
이상진 2025-07-14 17:01:11 +09:00
parent 38ef207c47
commit 98b9655a2f
10 changed files with 96 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/main/java/roomescape/auth/web/AuthAPI.kt
View File

@ -15,8 +15,8 @@ import org.springframework.web.bind.annotation.RequestBody
import org.springframework.web.bind.annotation.ResponseStatus import org.springframework.web.bind.annotation.ResponseStatus
import roomescape.auth.web.support.LoginRequired import roomescape.auth.web.support.LoginRequired
import roomescape.auth.web.support.MemberId import roomescape.auth.web.support.MemberId
import roomescape.common.dto.response.ErrorResponse import roomescape.common.dto.response.RoomescapeErrorResponse
import roomescape.common.dto.response.RoomEscapeApiResponse import roomescape.common.dto.response.RoomescapeApiResponse
@Tag(name = "1. 인증 / 인가 API", description = "로그인, 로그아웃 및 로그인 상태를 확인합니다") @Tag(name = "1. 인증 / 인가 API", description = "로그인, 로그아웃 및 로그인 상태를 확인합니다")
interface AuthAPI { interface AuthAPI {
@ -31,13 +31,13 @@ interface AuthAPI {
ApiResponse( ApiResponse(
responseCode = "400", responseCode = "400",
description = "존재하지 않는 회원이거나, 이메일 또는 비밀번호가 잘못 입력되었습니다.", description = "존재하지 않는 회원이거나, 이메일 또는 비밀번호가 잘못 입력되었습니다.",
content = [Content(schema = Schema(implementation = ErrorResponse::class))] content = [Content(schema = Schema(implementation = RoomescapeErrorResponse::class))]
) )
) )
fun login( fun login(
@Valid @RequestBody loginRequest: LoginRequest, @Valid @RequestBody loginRequest: LoginRequest,
response: HttpServletResponse response: HttpServletResponse
): RoomEscapeApiResponse<Void> ): RoomescapeApiResponse<Void>
@ResponseStatus(HttpStatus.OK) @ResponseStatus(HttpStatus.OK)
@Operation(summary = "로그인 상태 확인") @Operation(summary = "로그인 상태 확인")
@ -49,19 +49,19 @@ interface AuthAPI {
ApiResponse( ApiResponse(
responseCode = "400", responseCode = "400",
description = "쿠키에 있는 토큰 정보로 회원을 조회할 수 없습니다.", description = "쿠키에 있는 토큰 정보로 회원을 조회할 수 없습니다.",
content = [Content(schema = Schema(implementation = ErrorResponse::class))] content = [Content(schema = Schema(implementation = RoomescapeErrorResponse::class))]
), ),
ApiResponse( ApiResponse(
responseCode = "401", responseCode = "401",
description = "토큰 정보가 없거나, 만료되었습니다.", description = "토큰 정보가 없거나, 만료되었습니다.",
content = [Content(schema = Schema(implementation = ErrorResponse::class))] content = [Content(schema = Schema(implementation = RoomescapeErrorResponse::class))]
) )
) )
fun checkLogin(@MemberId @Parameter(hidden = true) memberId: Long): RoomEscapeApiResponse<LoginCheckResponse> fun checkLogin(@MemberId @Parameter(hidden = true) memberId: Long): RoomescapeApiResponse<LoginCheckResponse>
@LoginRequired @LoginRequired
@ResponseStatus(HttpStatus.OK) @ResponseStatus(HttpStatus.OK)
@Operation(summary = "로그아웃", tags = ["로그인이 필요한 API"]) @Operation(summary = "로그아웃", tags = ["로그인이 필요한 API"])
@ApiResponses(ApiResponse(responseCode = "200", description = "로그아웃 성공시 쿠키에 저장된 토큰 정보를 삭제합니다.")) @ApiResponses(ApiResponse(responseCode = "200", description = "로그아웃 성공시 쿠키에 저장된 토큰 정보를 삭제합니다."))
fun logout(request: HttpServletRequest, response: HttpServletResponse): RoomEscapeApiResponse<Void> fun logout(request: HttpServletRequest, response: HttpServletResponse): RoomescapeApiResponse<Void>
} }

14
src/main/java/roomescape/auth/web/AuthController.kt
View File

@ -15,7 +15,7 @@ import roomescape.auth.web.support.accessTokenCookie
import roomescape.auth.web.support.addAccessTokenCookie import roomescape.auth.web.support.addAccessTokenCookie
import roomescape.auth.web.support.expire import roomescape.auth.web.support.expire
import roomescape.auth.web.support.toCookie import roomescape.auth.web.support.toCookie
import roomescape.common.dto.response.RoomEscapeApiResponse import roomescape.common.dto.response.RoomescapeApiResponse
@RestController @RestController
class AuthController( class AuthController(
@ -26,33 +26,33 @@ class AuthController(
override fun login( override fun login(
@Valid @RequestBody loginRequest: LoginRequest, @Valid @RequestBody loginRequest: LoginRequest,
response: HttpServletResponse response: HttpServletResponse
): RoomEscapeApiResponse<Void> { ): RoomescapeApiResponse<Void> {
val accessToken: TokenResponse = authService.login(loginRequest) val accessToken: TokenResponse = authService.login(loginRequest)
val cookie: Cookie = accessToken.toCookie() val cookie: Cookie = accessToken.toCookie()
response.addAccessTokenCookie(cookie) response.addAccessTokenCookie(cookie)
return RoomEscapeApiResponse.success() return RoomescapeApiResponse.success()
} }
@GetMapping("/login/check") @GetMapping("/login/check")
override fun checkLogin( override fun checkLogin(
@MemberId @Parameter(hidden = true) memberId: Long @MemberId @Parameter(hidden = true) memberId: Long
): RoomEscapeApiResponse<LoginCheckResponse> { ): RoomescapeApiResponse<LoginCheckResponse> {
val response = authService.checkLogin(memberId) val response = authService.checkLogin(memberId)
return RoomEscapeApiResponse.success(response) return RoomescapeApiResponse.success(response)
} }
@PostMapping("/logout") @PostMapping("/logout")
override fun logout( override fun logout(
request: HttpServletRequest, request: HttpServletRequest,
response: HttpServletResponse response: HttpServletResponse
): RoomEscapeApiResponse<Void> { ): RoomescapeApiResponse<Void> {
val cookie: Cookie = request.accessTokenCookie() val cookie: Cookie = request.accessTokenCookie()
cookie.expire() cookie.expire()
response.addAccessTokenCookie(cookie) response.addAccessTokenCookie(cookie)
return RoomEscapeApiResponse.success() return RoomescapeApiResponse.success()
} }
} }

10
src/main/java/roomescape/common/dto/response/RoomEscapeApiResponse.kt → src/main/java/roomescape/common/dto/response/RoomescapeApiResponse.kt
View File

@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema
@Schema(description = "API 응답 시에 사용합니다.") @Schema(description = "API 응답 시에 사용합니다.")
@JvmRecord @JvmRecord
data class RoomEscapeApiResponse<T>( data class RoomescapeApiResponse<T>(
@field:Schema(description = "응답 메시지", defaultValue = SUCCESS_MESSAGE) @field:Schema(description = "응답 메시지", defaultValue = SUCCESS_MESSAGE)
val message: String, val message: String,
@ -15,13 +15,13 @@ data class RoomEscapeApiResponse<T>(
private const val SUCCESS_MESSAGE = "요청이 성공적으로 수행되었습니다." private const val SUCCESS_MESSAGE = "요청이 성공적으로 수행되었습니다."
@JvmStatic @JvmStatic
fun <T> success(data: T): RoomEscapeApiResponse<T> { fun <T> success(data: T): RoomescapeApiResponse<T> {
return RoomEscapeApiResponse(SUCCESS_MESSAGE, data) return RoomescapeApiResponse(SUCCESS_MESSAGE, data)
} }
@JvmStatic @JvmStatic
fun success(): RoomEscapeApiResponse<Void> { fun success(): RoomescapeApiResponse<Void> {
return RoomEscapeApiResponse(SUCCESS_MESSAGE, null) return RoomescapeApiResponse(SUCCESS_MESSAGE, null)
} }
} }
} }

6
src/main/java/roomescape/common/dto/response/ErrorResponse.kt → src/main/java/roomescape/common/dto/response/RoomescapeErrorResponse.kt
View File

@ -5,7 +5,7 @@ import roomescape.common.exception.ErrorType
@Schema(name = "예외 응답", description = "예외 발생 시 응답에 사용됩니다.") @Schema(name = "예외 응답", description = "예외 발생 시 응답에 사용됩니다.")
@JvmRecord @JvmRecord
data class ErrorResponse( data class RoomescapeErrorResponse(
@field:Schema(description = "발생한 예외의 종류", example = "INVALID_REQUEST_DATA") @field:Schema(description = "발생한 예외의 종류", example = "INVALID_REQUEST_DATA")
val errorType: ErrorType, val errorType: ErrorType,
@ -14,8 +14,8 @@ data class ErrorResponse(
) { ) {
companion object { companion object {
@JvmStatic @JvmStatic
fun of(errorType: ErrorType, message: String): ErrorResponse { fun of(errorType: ErrorType, message: String): RoomescapeErrorResponse {
return ErrorResponse(errorType, message) return RoomescapeErrorResponse(errorType, message)
} }
} }
} }

26
src/main/java/roomescape/common/exception/ExceptionControllerAdvice.kt
View File

@ -11,7 +11,7 @@ import org.springframework.web.bind.annotation.ExceptionHandler
import org.springframework.web.bind.annotation.ResponseStatus import org.springframework.web.bind.annotation.ResponseStatus
import org.springframework.web.bind.annotation.RestControllerAdvice import org.springframework.web.bind.annotation.RestControllerAdvice
import org.springframework.web.client.ResourceAccessException import org.springframework.web.client.ResourceAccessException
import roomescape.common.dto.response.ErrorResponse import roomescape.common.dto.response.RoomescapeErrorResponse
@RestControllerAdvice @RestControllerAdvice
class ExceptionControllerAdvice( class ExceptionControllerAdvice(
@ -22,54 +22,54 @@ class ExceptionControllerAdvice(
fun handleRoomEscapeException( fun handleRoomEscapeException(
e: RoomescapeException, e: RoomescapeException,
response: HttpServletResponse response: HttpServletResponse
): ErrorResponse { ): RoomescapeErrorResponse {
logger.error(e) { "message: ${e.message}, invalidValue: ${e.invalidValue}" } logger.error(e) { "message: ${e.message}, invalidValue: ${e.invalidValue}" }
response.status = e.httpStatus.value() response.status = e.httpStatus.value()
return ErrorResponse.of(e.errorType, e.message!!) return RoomescapeErrorResponse.of(e.errorType, e.message!!)
} }
@ExceptionHandler(ResourceAccessException::class) @ExceptionHandler(ResourceAccessException::class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
fun handleResourceAccessException(e: ResourceAccessException): ErrorResponse { fun handleResourceAccessException(e: ResourceAccessException): RoomescapeErrorResponse {
logger.error(e) { "message: ${e.message}" } logger.error(e) { "message: ${e.message}" }
return ErrorResponse.of(ErrorType.PAYMENT_SERVER_ERROR, ErrorType.PAYMENT_SERVER_ERROR.description) return RoomescapeErrorResponse.of(ErrorType.PAYMENT_SERVER_ERROR, ErrorType.PAYMENT_SERVER_ERROR.description)
} }
@ExceptionHandler(value = [HttpMessageNotReadableException::class]) @ExceptionHandler(value = [HttpMessageNotReadableException::class])
@ResponseStatus(HttpStatus.BAD_REQUEST) @ResponseStatus(HttpStatus.BAD_REQUEST)
fun handleHttpMessageNotReadableException(e: HttpMessageNotReadableException): ErrorResponse { fun handleHttpMessageNotReadableException(e: HttpMessageNotReadableException): RoomescapeErrorResponse {
logger.error(e) { "message: ${e.message}" } logger.error(e) { "message: ${e.message}" }
return ErrorResponse.of(ErrorType.INVALID_REQUEST_DATA_TYPE, return RoomescapeErrorResponse.of(ErrorType.INVALID_REQUEST_DATA_TYPE,
ErrorType.INVALID_REQUEST_DATA_TYPE.description) ErrorType.INVALID_REQUEST_DATA_TYPE.description)
} }
@ExceptionHandler(value = [MethodArgumentNotValidException::class]) @ExceptionHandler(value = [MethodArgumentNotValidException::class])
@ResponseStatus(HttpStatus.BAD_REQUEST) @ResponseStatus(HttpStatus.BAD_REQUEST)
fun handleMethodArgumentNotValidException(e: MethodArgumentNotValidException): ErrorResponse { fun handleMethodArgumentNotValidException(e: MethodArgumentNotValidException): RoomescapeErrorResponse {
val messages: String = e.bindingResult.allErrors val messages: String = e.bindingResult.allErrors
.mapNotNull { it.defaultMessage } .mapNotNull { it.defaultMessage }
.joinToString(", ") .joinToString(", ")
logger.error(e) { "message: $messages" } logger.error(e) { "message: $messages" }
return ErrorResponse.of(ErrorType.INVALID_REQUEST_DATA, messages) return RoomescapeErrorResponse.of(ErrorType.INVALID_REQUEST_DATA, messages)
} }
@ExceptionHandler(value = [HttpRequestMethodNotSupportedException::class]) @ExceptionHandler(value = [HttpRequestMethodNotSupportedException::class])
@ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED) @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
fun handleHttpRequestMethodNotSupportedException(e: HttpRequestMethodNotSupportedException): ErrorResponse { fun handleHttpRequestMethodNotSupportedException(e: HttpRequestMethodNotSupportedException): RoomescapeErrorResponse {
logger.error(e) { "message: ${e.message}" } logger.error(e) { "message: ${e.message}" }
return ErrorResponse.of(ErrorType.METHOD_NOT_ALLOWED, ErrorType.METHOD_NOT_ALLOWED.description) return RoomescapeErrorResponse.of(ErrorType.METHOD_NOT_ALLOWED, ErrorType.METHOD_NOT_ALLOWED.description)
} }
@ExceptionHandler(value = [Exception::class]) @ExceptionHandler(value = [Exception::class])
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
fun handleException(e: Exception): ErrorResponse { fun handleException(e: Exception): RoomescapeErrorResponse {
logger.error(e) { "message: ${e.message}" } logger.error(e) { "message: ${e.message}" }
return ErrorResponse.of(ErrorType.UNEXPECTED_ERROR, ErrorType.UNEXPECTED_ERROR.description) return RoomescapeErrorResponse.of(ErrorType.UNEXPECTED_ERROR, ErrorType.UNEXPECTED_ERROR.description)
} }
} }

4
src/main/java/roomescape/member/web/MemberAPI.kt
View File

@ -7,7 +7,7 @@ import io.swagger.v3.oas.annotations.tags.Tag
import org.springframework.http.HttpStatus import org.springframework.http.HttpStatus
import org.springframework.web.bind.annotation.ResponseStatus import org.springframework.web.bind.annotation.ResponseStatus
import roomescape.auth.web.support.Admin import roomescape.auth.web.support.Admin
import roomescape.common.dto.response.RoomEscapeApiResponse import roomescape.common.dto.response.RoomescapeApiResponse
@Tag(name = "2. 회원 API", description = "회원 정보를 관리할 때 사용합니다.") @Tag(name = "2. 회원 API", description = "회원 정보를 관리할 때 사용합니다.")
interface MemberAPI { interface MemberAPI {
@ -16,6 +16,6 @@ interface MemberAPI {
@Operation(summary = "모든 회원 조회", tags = ["관리자 로그인이 필요한 API"]) @Operation(summary = "모든 회원 조회", tags = ["관리자 로그인이 필요한 API"])
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)) @ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
@ResponseStatus(HttpStatus.OK) @ResponseStatus(HttpStatus.OK)
fun readAllMembers(): RoomEscapeApiResponse<MembersResponse> fun readAllMembers(): RoomescapeApiResponse<MembersResponse>
} }

6
src/main/java/roomescape/member/web/MemberController.kt
View File

@ -5,7 +5,7 @@ import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RestController import org.springframework.web.bind.annotation.RestController
import roomescape.member.business.MemberService import roomescape.member.business.MemberService
import roomescape.member.infrastructure.persistence.Member import roomescape.member.infrastructure.persistence.Member
import roomescape.common.dto.response.RoomEscapeApiResponse import roomescape.common.dto.response.RoomescapeApiResponse
@RestController @RestController
class MemberController( class MemberController(
@ -13,10 +13,10 @@ class MemberController(
) : MemberAPI { ) : MemberAPI {
@GetMapping("/members") @GetMapping("/members")
override fun readAllMembers(): RoomEscapeApiResponse<MembersResponse> { override fun readAllMembers(): RoomescapeApiResponse<MembersResponse> {
val result: MembersResponse = memberService.readAllMembers() val result: MembersResponse = memberService.readAllMembers()
return RoomEscapeApiResponse.success(result) return RoomescapeApiResponse.success(result)
} }
} }

62
src/main/java/roomescape/reservation/controller/ReservationController.java
View File

@ -40,8 +40,8 @@ import roomescape.reservation.service.ReservationWithPaymentService;
import roomescape.auth.web.support.Admin; import roomescape.auth.web.support.Admin;
import roomescape.auth.web.support.LoginRequired; import roomescape.auth.web.support.LoginRequired;
import roomescape.auth.web.support.MemberId; import roomescape.auth.web.support.MemberId;
import roomescape.common.dto.response.ErrorResponse; import roomescape.common.dto.response.RoomescapeErrorResponse;
import roomescape.common.dto.response.RoomEscapeApiResponse; import roomescape.common.dto.response.RoomescapeApiResponse;
import roomescape.common.exception.RoomescapeException; import roomescape.common.exception.RoomescapeException;
@RestController @RestController
@ -66,8 +66,8 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true) @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
}) })
public RoomEscapeApiResponse<ReservationsResponse> getAllReservations() { public RoomescapeApiResponse<ReservationsResponse> getAllReservations() {
return RoomEscapeApiResponse.success(reservationService.findAllReservations()); return RoomescapeApiResponse.success(reservationService.findAllReservations());
} }
@LoginRequired @LoginRequired
@ -77,9 +77,9 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true) @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
}) })
public RoomEscapeApiResponse<MyReservationsResponse> getMemberReservations( public RoomescapeApiResponse<MyReservationsResponse> getMemberReservations(
@MemberId @Parameter(hidden = true) Long memberId) { @MemberId @Parameter(hidden = true) Long memberId) {
return RoomEscapeApiResponse.success(reservationService.findMemberReservations(memberId)); return RoomescapeApiResponse.success(reservationService.findMemberReservations(memberId));
} }
@Admin @Admin
@ -89,15 +89,15 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true), @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true),
@ApiResponse(responseCode = "400", description = "날짜 범위를 지정할 때, 종료 날짜는 시작 날짜 이전일 수 없습니다.", @ApiResponse(responseCode = "400", description = "날짜 범위를 지정할 때, 종료 날짜는 시작 날짜 이전일 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<ReservationsResponse> getReservationBySearching( public RoomescapeApiResponse<ReservationsResponse> getReservationBySearching(
@RequestParam(required = false) @Parameter(description = "테마 ID") Long themeId, @RequestParam(required = false) @Parameter(description = "테마 ID") Long themeId,
@RequestParam(required = false) @Parameter(description = "회원 ID") Long memberId, @RequestParam(required = false) @Parameter(description = "회원 ID") Long memberId,
@RequestParam(required = false) @Parameter(description = "yyyy-MM-dd 형식으로 입력해주세요", example = "2024-06-10") LocalDate dateFrom, @RequestParam(required = false) @Parameter(description = "yyyy-MM-dd 형식으로 입력해주세요", example = "2024-06-10") LocalDate dateFrom,
@RequestParam(required = false) @Parameter(description = "yyyy-MM-dd 형식으로 입력해주세요", example = "2024-06-10") LocalDate dateTo @RequestParam(required = false) @Parameter(description = "yyyy-MM-dd 형식으로 입력해주세요", example = "2024-06-10") LocalDate dateTo
) { ) {
return RoomEscapeApiResponse.success( return RoomescapeApiResponse.success(
reservationService.findFilteredReservations(themeId, memberId, dateFrom, dateTo)); reservationService.findFilteredReservations(themeId, memberId, dateFrom, dateTo));
} }
@ -108,16 +108,16 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "204", description = "성공"), @ApiResponse(responseCode = "204", description = "성공"),
@ApiResponse(responseCode = "404", description = "예약 또는 결제 정보를 찾을 수 없습니다.", @ApiResponse(responseCode = "404", description = "예약 또는 결제 정보를 찾을 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))), content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class))),
}) })
public RoomEscapeApiResponse<Void> removeReservation( public RoomescapeApiResponse<Void> removeReservation(
@MemberId @Parameter(hidden = true) Long memberId, @MemberId @Parameter(hidden = true) Long memberId,
@NotNull(message = "reservationId는 null일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId @NotNull(message = "reservationId는 null일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId
) { ) {
if (reservationWithPaymentService.isNotPaidReservation(reservationId)) { if (reservationWithPaymentService.isNotPaidReservation(reservationId)) {
reservationService.removeReservationById(reservationId, memberId); reservationService.removeReservationById(reservationId, memberId);
return RoomEscapeApiResponse.success(); return RoomescapeApiResponse.success();
} }
PaymentCancelRequest paymentCancelRequest = reservationWithPaymentService.removeReservationWithPayment( PaymentCancelRequest paymentCancelRequest = reservationWithPaymentService.removeReservationWithPayment(
@ -128,7 +128,7 @@ public class ReservationController {
reservationWithPaymentService.updateCanceledTime(paymentCancelRequest.paymentKey(), reservationWithPaymentService.updateCanceledTime(paymentCancelRequest.paymentKey(),
paymentCancelResponse.canceledAt()); paymentCancelResponse.canceledAt());
return RoomEscapeApiResponse.success(); return RoomescapeApiResponse.success();
} }
@LoginRequired @LoginRequired
@ -139,7 +139,7 @@ public class ReservationController {
@ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true, @ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true,
headers = @Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = @Schema(example = "/reservations/1"))) headers = @Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = @Schema(example = "/reservations/1")))
}) })
public RoomEscapeApiResponse<ReservationResponse> saveReservation( public RoomescapeApiResponse<ReservationResponse> saveReservation(
@Valid @RequestBody ReservationRequest reservationRequest, @Valid @RequestBody ReservationRequest reservationRequest,
@MemberId @Parameter(hidden = true) Long memberId, @MemberId @Parameter(hidden = true) Long memberId,
HttpServletResponse response HttpServletResponse response
@ -170,9 +170,9 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true, @ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true,
headers = @Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = @Schema(example = "/reservations/1"))), headers = @Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = @Schema(example = "/reservations/1"))),
@ApiResponse(responseCode = "409", description = "예약이 이미 존재합니다.", content = @Content(schema = @Schema(implementation = ErrorResponse.class))) @ApiResponse(responseCode = "409", description = "예약이 이미 존재합니다.", content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<ReservationResponse> saveReservationByAdmin( public RoomescapeApiResponse<ReservationResponse> saveReservationByAdmin(
@Valid @RequestBody AdminReservationRequest adminReservationRequest, @Valid @RequestBody AdminReservationRequest adminReservationRequest,
HttpServletResponse response HttpServletResponse response
) { ) {
@ -187,8 +187,8 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true) @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
}) })
public RoomEscapeApiResponse<ReservationsResponse> getAllWaiting() { public RoomescapeApiResponse<ReservationsResponse> getAllWaiting() {
return RoomEscapeApiResponse.success(reservationService.findAllWaiting()); return RoomescapeApiResponse.success(reservationService.findAllWaiting());
} }
@LoginRequired @LoginRequired
@ -199,7 +199,7 @@ public class ReservationController {
@ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true, @ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true,
headers = @Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = @Schema(example = "/reservations/1"))) headers = @Header(name = HttpHeaders.LOCATION, description = "생성된 예약 정보 URL", schema = @Schema(example = "/reservations/1")))
}) })
public RoomEscapeApiResponse<ReservationResponse> saveWaiting( public RoomescapeApiResponse<ReservationResponse> saveWaiting(
@Valid @RequestBody WaitingRequest waitingRequest, @Valid @RequestBody WaitingRequest waitingRequest,
@MemberId @Parameter(hidden = true) Long memberId, @MemberId @Parameter(hidden = true) Long memberId,
HttpServletResponse response HttpServletResponse response
@ -215,14 +215,14 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "204", description = "성공"), @ApiResponse(responseCode = "204", description = "성공"),
@ApiResponse(responseCode = "404", description = "회원의 예약 대기 정보를 찾을 수 없습니다.", @ApiResponse(responseCode = "404", description = "회원의 예약 대기 정보를 찾을 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<Void> deleteWaiting( public RoomescapeApiResponse<Void> deleteWaiting(
@MemberId @Parameter(hidden = true) Long memberId, @MemberId @Parameter(hidden = true) Long memberId,
@NotNull(message = "reservationId는 null 또는 공백일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId @NotNull(message = "reservationId는 null 또는 공백일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId
) { ) {
reservationService.cancelWaiting(reservationId, memberId); reservationService.cancelWaiting(reservationId, memberId);
return RoomEscapeApiResponse.success(); return RoomescapeApiResponse.success();
} }
@Admin @Admin
@ -232,17 +232,17 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공"), @ApiResponse(responseCode = "200", description = "성공"),
@ApiResponse(responseCode = "404", description = "예약 대기 정보를 찾을 수 없습니다.", @ApiResponse(responseCode = "404", description = "예약 대기 정보를 찾을 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))), content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class))),
@ApiResponse(responseCode = "409", description = "확정된 예약이 존재하여 대기 중인 예약을 승인할 수 없습니다.", @ApiResponse(responseCode = "409", description = "확정된 예약이 존재하여 대기 중인 예약을 승인할 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<Void> approveWaiting( public RoomescapeApiResponse<Void> approveWaiting(
@MemberId @Parameter(hidden = true) Long memberId, @MemberId @Parameter(hidden = true) Long memberId,
@NotNull(message = "reservationId는 null 또는 공백일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId @NotNull(message = "reservationId는 null 또는 공백일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId
) { ) {
reservationService.approveWaiting(reservationId, memberId); reservationService.approveWaiting(reservationId, memberId);
return RoomEscapeApiResponse.success(); return RoomescapeApiResponse.success();
} }
@Admin @Admin
@ -252,22 +252,22 @@ public class ReservationController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "204", description = "대기 중인 예약 거절 성공"), @ApiResponse(responseCode = "204", description = "대기 중인 예약 거절 성공"),
@ApiResponse(responseCode = "404", description = "예약 대기 정보를 찾을 수 없습니다.", @ApiResponse(responseCode = "404", description = "예약 대기 정보를 찾을 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<Void> denyWaiting( public RoomescapeApiResponse<Void> denyWaiting(
@MemberId @Parameter(hidden = true) Long memberId, @MemberId @Parameter(hidden = true) Long memberId,
@NotNull(message = "reservationId는 null 또는 공백일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId @NotNull(message = "reservationId는 null 또는 공백일 수 없습니다.") @PathVariable("id") @Parameter(description = "예약 ID") Long reservationId
) { ) {
reservationService.denyWaiting(reservationId, memberId); reservationService.denyWaiting(reservationId, memberId);
return RoomEscapeApiResponse.success(); return RoomescapeApiResponse.success();
} }
private RoomEscapeApiResponse<ReservationResponse> getCreatedReservationResponse( private RoomescapeApiResponse<ReservationResponse> getCreatedReservationResponse(
ReservationResponse reservationResponse, ReservationResponse reservationResponse,
HttpServletResponse response HttpServletResponse response
) { ) {
response.setHeader(HttpHeaders.LOCATION, "/reservations/" + reservationResponse.id()); response.setHeader(HttpHeaders.LOCATION, "/reservations/" + reservationResponse.id());
return RoomEscapeApiResponse.success(reservationResponse); return RoomescapeApiResponse.success(reservationResponse);
} }
} }

24
src/main/java/roomescape/reservation/controller/ReservationTimeController.java
View File

@ -30,8 +30,8 @@ import roomescape.reservation.dto.response.ReservationTimesResponse;
import roomescape.reservation.service.ReservationTimeService; import roomescape.reservation.service.ReservationTimeService;
import roomescape.auth.web.support.Admin; import roomescape.auth.web.support.Admin;
import roomescape.auth.web.support.LoginRequired; import roomescape.auth.web.support.LoginRequired;
import roomescape.common.dto.response.ErrorResponse; import roomescape.common.dto.response.RoomescapeErrorResponse;
import roomescape.common.dto.response.RoomEscapeApiResponse; import roomescape.common.dto.response.RoomescapeApiResponse;
@RestController @RestController
@Tag(name = "4. 예약 시간 API", description = "예약 시간을 조회 / 추가 / 삭제할 때 사용합니다.") @Tag(name = "4. 예약 시간 API", description = "예약 시간을 조회 / 추가 / 삭제할 때 사용합니다.")
@ -50,8 +50,8 @@ public class ReservationTimeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true) @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
}) })
public RoomEscapeApiResponse<ReservationTimesResponse> getAllTimes() { public RoomescapeApiResponse<ReservationTimesResponse> getAllTimes() {
return RoomEscapeApiResponse.success(reservationTimeService.findAllTimes()); return RoomescapeApiResponse.success(reservationTimeService.findAllTimes());
} }
@Admin @Admin
@ -61,16 +61,16 @@ public class ReservationTimeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true), @ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true),
@ApiResponse(responseCode = "409", description = "같은 시간을 추가할 수 없습니다.", @ApiResponse(responseCode = "409", description = "같은 시간을 추가할 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<ReservationTimeResponse> saveTime( public RoomescapeApiResponse<ReservationTimeResponse> saveTime(
@Valid @RequestBody ReservationTimeRequest reservationTimeRequest, @Valid @RequestBody ReservationTimeRequest reservationTimeRequest,
HttpServletResponse response HttpServletResponse response
) { ) {
ReservationTimeResponse reservationTimeResponse = reservationTimeService.addTime(reservationTimeRequest); ReservationTimeResponse reservationTimeResponse = reservationTimeService.addTime(reservationTimeRequest);
response.setHeader(HttpHeaders.LOCATION, "/times/" + reservationTimeResponse.id()); response.setHeader(HttpHeaders.LOCATION, "/times/" + reservationTimeResponse.id());
return RoomEscapeApiResponse.success(reservationTimeResponse); return RoomescapeApiResponse.success(reservationTimeResponse);
} }
@Admin @Admin
@ -80,14 +80,14 @@ public class ReservationTimeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "204", description = "성공", useReturnTypeSchema = true), @ApiResponse(responseCode = "204", description = "성공", useReturnTypeSchema = true),
@ApiResponse(responseCode = "409", description = "예약된 시간은 삭제할 수 없습니다.", @ApiResponse(responseCode = "409", description = "예약된 시간은 삭제할 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<Void> removeTime( public RoomescapeApiResponse<Void> removeTime(
@NotNull(message = "timeId는 null 또는 공백일 수 없습니다.") @PathVariable @Parameter(description = "삭제하고자 하는 시간의 ID값") Long id @NotNull(message = "timeId는 null 또는 공백일 수 없습니다.") @PathVariable @Parameter(description = "삭제하고자 하는 시간의 ID값") Long id
) { ) {
reservationTimeService.removeTimeById(id); reservationTimeService.removeTimeById(id);
return RoomEscapeApiResponse.success(); return RoomescapeApiResponse.success();
} }
@LoginRequired @LoginRequired
@ -97,7 +97,7 @@ public class ReservationTimeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true) @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
}) })
public RoomEscapeApiResponse<ReservationTimeInfosResponse> findAllAvailableReservationTimes( public RoomescapeApiResponse<ReservationTimeInfosResponse> findAllAvailableReservationTimes(
@NotNull(message = "날짜는 null일 수 없습니다.") @NotNull(message = "날짜는 null일 수 없습니다.")
@RequestParam @RequestParam
@Parameter(description = "yyyy-MM-dd 형식으로 입력해주세요.", example = "2024-06-10") @Parameter(description = "yyyy-MM-dd 형식으로 입력해주세요.", example = "2024-06-10")
@ -107,6 +107,6 @@ public class ReservationTimeController {
@Parameter(description = "조회할 테마의 ID를 입력해주세요.", example = "1") @Parameter(description = "조회할 테마의 ID를 입력해주세요.", example = "1")
Long themeId Long themeId
) { ) {
return RoomEscapeApiResponse.success(reservationTimeService.findAllAvailableTimesByDateAndTheme(date, themeId)); return RoomescapeApiResponse.success(reservationTimeService.findAllAvailableTimesByDateAndTheme(date, themeId));
} }
} }

24
src/main/java/roomescape/theme/controller/ThemeController.java
View File

@ -23,8 +23,8 @@ import jakarta.validation.Valid;
import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.NotNull;
import roomescape.auth.web.support.Admin; import roomescape.auth.web.support.Admin;
import roomescape.auth.web.support.LoginRequired; import roomescape.auth.web.support.LoginRequired;
import roomescape.common.dto.response.ErrorResponse; import roomescape.common.dto.response.RoomescapeErrorResponse;
import roomescape.common.dto.response.RoomEscapeApiResponse; import roomescape.common.dto.response.RoomescapeApiResponse;
import roomescape.theme.dto.ThemeRequest; import roomescape.theme.dto.ThemeRequest;
import roomescape.theme.dto.ThemeResponse; import roomescape.theme.dto.ThemeResponse;
import roomescape.theme.dto.ThemesResponse; import roomescape.theme.dto.ThemesResponse;
@ -47,8 +47,8 @@ public class ThemeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true) @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
}) })
public RoomEscapeApiResponse<ThemesResponse> getAllThemes() { public RoomescapeApiResponse<ThemesResponse> getAllThemes() {
return RoomEscapeApiResponse.success(themeService.findAllThemes()); return RoomescapeApiResponse.success(themeService.findAllThemes());
} }
@GetMapping("/themes/most-reserved-last-week") @GetMapping("/themes/most-reserved-last-week")
@ -57,10 +57,10 @@ public class ThemeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true) @ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
}) })
public RoomEscapeApiResponse<ThemesResponse> getMostReservedThemes( public RoomescapeApiResponse<ThemesResponse> getMostReservedThemes(
@RequestParam(defaultValue = "10") @Parameter(description = "최대로 조회할 테마 갯수") int count @RequestParam(defaultValue = "10") @Parameter(description = "최대로 조회할 테마 갯수") int count
) { ) {
return RoomEscapeApiResponse.success(themeService.getMostReservedThemesByCount(count)); return RoomescapeApiResponse.success(themeService.getMostReservedThemesByCount(count));
} }
@Admin @Admin
@ -70,16 +70,16 @@ public class ThemeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true), @ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true),
@ApiResponse(responseCode = "409", description = "같은 이름의 테마를 추가할 수 없습니다.", @ApiResponse(responseCode = "409", description = "같은 이름의 테마를 추가할 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<ThemeResponse> saveTheme( public RoomescapeApiResponse<ThemeResponse> saveTheme(
@Valid @RequestBody ThemeRequest request, @Valid @RequestBody ThemeRequest request,
HttpServletResponse response HttpServletResponse response
) { ) {
ThemeResponse themeResponse = themeService.addTheme(request); ThemeResponse themeResponse = themeService.addTheme(request);
response.setHeader(HttpHeaders.LOCATION, "/themes/" + themeResponse.id()); response.setHeader(HttpHeaders.LOCATION, "/themes/" + themeResponse.id());
return RoomEscapeApiResponse.success(themeResponse); return RoomescapeApiResponse.success(themeResponse);
} }
@Admin @Admin
@ -89,13 +89,13 @@ public class ThemeController {
@ApiResponses({ @ApiResponses({
@ApiResponse(responseCode = "204", description = "성공", useReturnTypeSchema = true), @ApiResponse(responseCode = "204", description = "성공", useReturnTypeSchema = true),
@ApiResponse(responseCode = "409", description = "예약된 테마는 삭제할 수 없습니다.", @ApiResponse(responseCode = "409", description = "예약된 테마는 삭제할 수 없습니다.",
content = @Content(schema = @Schema(implementation = ErrorResponse.class))) content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
}) })
public RoomEscapeApiResponse<Void> removeTheme( public RoomescapeApiResponse<Void> removeTheme(
@NotNull(message = "themeId는 null일 수 없습니다.") @PathVariable Long id @NotNull(message = "themeId는 null일 수 없습니다.") @PathVariable Long id
) { ) {
themeService.removeThemeById(id); themeService.removeThemeById(id);
return RoomEscapeApiResponse.success(); return RoomescapeApiResponse.success();
} }
} }