From a87651629612dfcffb04aae63f9694d2d9491ad4 Mon Sep 17 00:00:00 2001 From: pricelees Date: Mon, 14 Jul 2025 17:05:11 +0900 Subject: [PATCH] =?UTF-8?q?refactor:=20API=20/=20=EC=97=90=EB=9F=AC=20?= =?UTF-8?q?=EC=9D=91=EB=8B=B5=20=EA=B0=9D=EC=B2=B4=20Swagger=20Schema=20?= =?UTF-8?q?=EC=A0=9C=EA=B1=B0=20=EB=B0=8F=20=EC=BD=94=EB=93=9C=20=EA=B0=84?= =?UTF-8?q?=EC=86=8C=ED=99=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../dto/response/RoomescapeApiResponse.kt | 18 ++++-------------- .../dto/response/RoomescapeErrorResponse.kt | 11 ++++------- 2 files changed, 8 insertions(+), 21 deletions(-) diff --git a/src/main/java/roomescape/common/dto/response/RoomescapeApiResponse.kt b/src/main/java/roomescape/common/dto/response/RoomescapeApiResponse.kt index 2ad3f526..a3ef0631 100644 --- a/src/main/java/roomescape/common/dto/response/RoomescapeApiResponse.kt +++ b/src/main/java/roomescape/common/dto/response/RoomescapeApiResponse.kt @@ -2,26 +2,16 @@ package roomescape.common.dto.response import io.swagger.v3.oas.annotations.media.Schema -@Schema(description = "API 응답 시에 사용합니다.") +@Schema(name = "API 성공 응답") @JvmRecord data class RoomescapeApiResponse( - @field:Schema(description = "응답 메시지", defaultValue = SUCCESS_MESSAGE) - val message: String, - - @field:Schema(description = "응답 바디") val data: T? = null ) { companion object { - private const val SUCCESS_MESSAGE = "요청이 성공적으로 수행되었습니다." + @JvmStatic + fun success(data: T): RoomescapeApiResponse = RoomescapeApiResponse(data) @JvmStatic - fun success(data: T): RoomescapeApiResponse { - return RoomescapeApiResponse(SUCCESS_MESSAGE, data) - } - - @JvmStatic - fun success(): RoomescapeApiResponse { - return RoomescapeApiResponse(SUCCESS_MESSAGE, null) - } + fun success(): RoomescapeApiResponse = RoomescapeApiResponse(null) } } diff --git a/src/main/java/roomescape/common/dto/response/RoomescapeErrorResponse.kt b/src/main/java/roomescape/common/dto/response/RoomescapeErrorResponse.kt index e7c3801d..045a33c2 100644 --- a/src/main/java/roomescape/common/dto/response/RoomescapeErrorResponse.kt +++ b/src/main/java/roomescape/common/dto/response/RoomescapeErrorResponse.kt @@ -3,19 +3,16 @@ package roomescape.common.dto.response import io.swagger.v3.oas.annotations.media.Schema import roomescape.common.exception.ErrorType -@Schema(name = "예외 응답", description = "예외 발생 시 응답에 사용됩니다.") +@Schema(name = "API 에러 응답") @JvmRecord data class RoomescapeErrorResponse( - @field:Schema(description = "발생한 예외의 종류", example = "INVALID_REQUEST_DATA") val errorType: ErrorType, - - @field:Schema(description = "예외 메시지", example = "요청 데이터 값이 올바르지 않습니다.") val message: String ) { + companion object { @JvmStatic - fun of(errorType: ErrorType, message: String): RoomescapeErrorResponse { - return RoomescapeErrorResponse(errorType, message) - } + fun of(errorType: ErrorType, message: String? = null): RoomescapeErrorResponse = + RoomescapeErrorResponse(errorType, message ?: errorType.description) } }