Merge pull request #26 from Block-Guard/docs/#25/swagger-response-fix

chaeyuuu · web-flow · commit 8290982df781 · 2025-07-25T16:13:47.000+09:00
[Docs] Swagger Error 예시 응답 수정 &amp;
diff --git a/src/main/java/com/blockguard/server/domain/guardian/dto/request/CreateGuardianRequest.java b/src/main/java/com/blockguard/server/domain/guardian/dto/request/CreateGuardianRequest.java
@@ -16,7 +16,7 @@ public class CreateGuardianRequest {
     private String name;
 
     @NotBlank
-    @Pattern(regexp = "^010-\\d{4}-\\d{4}$", message = "010-1234-5678 형식이어야 합니다.")
+    @Pattern(regexp = "^\\d{3}-\\d{4}-\\d{4}$", message = "phoneNumber must match 010-1234-5678 format")
     private String phoneNumber;
 
     @Schema(requiredMode = Schema.RequiredMode.NOT_REQUIRED)
diff --git a/src/main/java/com/blockguard/server/domain/user/api/UserApi.java b/src/main/java/com/blockguard/server/domain/user/api/UserApi.java
@@ -12,6 +12,7 @@
 import com.blockguard.server.global.config.swagger.SwaggerResponseDescription;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
+import jakarta.validation.Valid;
 import lombok.AllArgsConstructor;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.*;
@@ -23,6 +24,7 @@ public class UserApi {
     private final UserService userService;
 
     @GetMapping("/me")
+    @CustomExceptionDescription(SwaggerResponseDescription.INVALID_TOKEN)
     @Operation(summary = "마이페이지 조회")
     public BaseResponse<MyPageResponse> getMyPageInfo(@Parameter(hidden = true) @CurrentUser User user){
         MyPageResponse myPageResponse = userService.getMyPageInfo(user);
@@ -33,14 +35,14 @@ public BaseResponse<MyPageResponse> getMyPageInfo(@Parameter(hidden = true) @Cur
     @CustomExceptionDescription(SwaggerResponseDescription.UPDATE_MY_PAGE_INFO_FAIL)
     @Operation(summary = "회원 정보 수정", description = "아이디를 제외하고 수정가능합니다. 생년월일 형식은 'yyyyMMDD'로 입력해야합니다.")
     public BaseResponse<Void> updateUserInfo(@Parameter(hidden = true) @CurrentUser User user,
-                                             @ModelAttribute UpdateUserInfo updateUserInfo){
+                                             @Valid @ModelAttribute UpdateUserInfo updateUserInfo){
         userService.updateUserInfo(user.getId(), updateUserInfo);
         return BaseResponse.of(SuccessCode.UPDATE_USER_INFO_SUCCESS);
 
     }
 
     @PutMapping(value = "/me/password")
-    @CustomExceptionDescription(SwaggerResponseDescription.UPDATE_MY_PAGE_INFO_FAIL)
+    @CustomExceptionDescription(SwaggerResponseDescription.UPDATE_PASSWORD_FAIL)
     @Operation(summary = "비밀번호 변경", description = "현재 비밀번호를 확인하고, 새 비밀번호로 변경합니다.")
     public BaseResponse<Void> updatePassword(@Parameter(hidden = true) @CurrentUser User user,
     @RequestBody UpdatePasswordRequest updatePasswordRequest){
@@ -50,12 +52,11 @@ public BaseResponse<Void> updatePassword(@Parameter(hidden = true) @CurrentUser
     }
 
     @DeleteMapping("/withdraw")
+    @CustomExceptionDescription(SwaggerResponseDescription.INVALID_TOKEN)
     @Operation(summary = "회원 탈퇴")
     public BaseResponse<Void> withdraw(@Parameter(hidden = true) @CurrentUser User user){
         userService.withdraw(user.getId());
         return BaseResponse.of(SuccessCode.WITHDRAW_SUCCESS);
     }
 
-
-
 }
diff --git a/src/main/java/com/blockguard/server/domain/user/dto/request/UpdateUserInfo.java b/src/main/java/com/blockguard/server/domain/user/dto/request/UpdateUserInfo.java
@@ -1,5 +1,9 @@
 package com.blockguard.server.domain.user.dto.request;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Pattern;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
@@ -9,9 +13,19 @@
 @AllArgsConstructor
 @Builder
 public class UpdateUserInfo {
+    @NotBlank
     private String name;
+
+    @NotBlank
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyyMMdd")
+    @Schema(description = "생년월일 yyyyMMdd", example = "20000101")
     private String birthDate; //yyyyMMDD
+
+    @NotBlank
+    @Pattern(regexp = "^\\d{3}-\\d{4}-\\d{4}$",
+            message = "phoneNumber must match 010-1234-5678 format")
     private String phoneNumber;
+
     private MultipartFile profileImage;
 
 }
diff --git a/src/main/java/com/blockguard/server/global/config/swagger/SwaggerResponseDescription.java b/src/main/java/com/blockguard/server/global/config/swagger/SwaggerResponseDescription.java
@@ -9,7 +9,10 @@
 @Getter
 public enum SwaggerResponseDescription {
     REGISTER_FAIL(new LinkedHashSet<>(Set.of(
-            ErrorCode.DUPLICATED_EMAIL
+            ErrorCode.DUPLICATED_EMAIL,
+            ErrorCode.INVALID_EMAIL_TYPE,
+            ErrorCode.INVALID_PHONE_NUMBER_FORMAT,
+            ErrorCode.INVALID_DATE_FORMAT
     ))),
 
     LOGIN_FAIL(new LinkedHashSet<>(Set.of(
@@ -18,26 +21,38 @@ public enum SwaggerResponseDescription {
     ))),
 
     FIND_EMAIL_FAIL(new LinkedHashSet<>(Set.of(
-            ErrorCode.USER_INFO_NOT_FOUND
+            ErrorCode.USER_INFO_NOT_FOUND,
+            ErrorCode.INVALID_PHONE_NUMBER_FORMAT,
+            ErrorCode.INVALID_DATE_FORMAT
     ))),
 
     UPDATE_MY_PAGE_INFO_FAIL(new LinkedHashSet<>(Set.of(
             ErrorCode.INVALID_PHONE_NUMBER_FORMAT,
+            ErrorCode.INVALID_DATE_FORMAT,
             ErrorCode.INVALID_PROFILE_IMAGE,
+            ErrorCode.INVALID_TOKEN,
             ErrorCode.FILE_NAME_NOT_FOUND,
             ErrorCode.INVALID_DIRECTORY_ROUTE,
             ErrorCode.FILE_SIZE_EXCEEDED
     ))),
 
+    UPDATE_PASSWORD_FAIL(new LinkedHashSet<>(Set.of(
+            ErrorCode.INVALID_TOKEN,
+            ErrorCode.PASSWORD_MISMATCH
+    ))),
+
     FIND_PASSWORD_FAIL(new LinkedHashSet<>(Set.of(
-            ErrorCode.EMAIL_NOT_FOUND
+            ErrorCode.EMAIL_NOT_FOUND,
+            ErrorCode.INVALID_EMAIL_TYPE
     ))),
 
     FIND_GUARDIANS_FAIL(new LinkedHashSet<>(Set.of(
+            ErrorCode.INVALID_TOKEN,
             ErrorCode.USER_INFO_NOT_FOUND
     ))),
 
     CREATE_GUARDIAN_FAIL(new LinkedHashSet<>(Set.of(
+            ErrorCode.INVALID_TOKEN,
             ErrorCode.INVALID_PHONE_NUMBER_FORMAT,
             ErrorCode.INVALID_PROFILE_IMAGE,
             ErrorCode.FILE_NAME_NOT_FOUND,
@@ -47,6 +62,7 @@ public enum SwaggerResponseDescription {
     ))),
 
     UPDATE_GUARDIAN_FAIL(new LinkedHashSet<>(Set.of(
+            ErrorCode.INVALID_TOKEN,
             ErrorCode.INVALID_PHONE_NUMBER_FORMAT,
             ErrorCode.INVALID_PROFILE_IMAGE,
             ErrorCode.GUARDIAN_NOT_FOUND,
@@ -57,21 +73,25 @@ public enum SwaggerResponseDescription {
     ))),
 
     UPDATE_GUARDIAN_PRIMARY_FAIL(new LinkedHashSet<>(Set.of(
+            ErrorCode.INVALID_TOKEN,
             ErrorCode.GUARDIAN_NOT_FOUND
     ))),
 
     CHECK_EMAIL_DUPLICATED_FAIL(new LinkedHashSet<>(Set.of(
             ErrorCode.INVALID_EMAIL_TYPE
+    ))),
+
+    INVALID_TOKEN(new LinkedHashSet<>(Set.of(
+            ErrorCode.INVALID_TOKEN
     )));
 
     private final Set<ErrorCode> errorCodeList;
 
     SwaggerResponseDescription(Set<ErrorCode> errorCodes) {
         // 공통 에러 추가
-        errorCodes.addAll(Set.of(
-                ErrorCode.INVALID_TOKEN,
+        errorCodes.add(
                 ErrorCode.INTERNAL_SERVER_ERROR
-        ));
+        );
 
         this.errorCodeList = errorCodes;
     }
diff --git a/src/main/java/com/blockguard/server/global/exception/GlobalExceptionHandler.java b/src/main/java/com/blockguard/server/global/exception/GlobalExceptionHandler.java
@@ -2,9 +2,11 @@
 
 import com.blockguard.server.global.common.codes.ErrorCode;
 import com.blockguard.server.global.common.response.ErrorResponse;
+import com.fasterxml.jackson.databind.exc.InvalidFormatException;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.context.support.DefaultMessageSourceResolvable;
 import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
@@ -32,17 +34,42 @@ protected ResponseEntity<ErrorResponse> handleValidationException(MethodArgument
 
         log.warn("[ValidationException] message: {}", message);
 
-        if (message.contains("이메일 형식")) {
+        if (message.contains("이메일")) {
             return ResponseEntity
                     .status(ErrorCode.INVALID_EMAIL_TYPE.getStatus())
                     .body(ErrorResponse.of(ErrorCode.INVALID_EMAIL_TYPE));
         }
 
+        if (message.contains("phoneNumber")) {
+            return ResponseEntity
+                    .status(ErrorCode.INVALID_PHONE_NUMBER_FORMAT.getStatus())
+                    .body(ErrorResponse.of(ErrorCode.INVALID_PHONE_NUMBER_FORMAT));
+        }
+
         return ResponseEntity
                 .status(ErrorCode.INVALID_REQUEST.getStatus())
                 .body(ErrorResponse.of(ErrorCode.INVALID_REQUEST, message));
     }
 
+    @ExceptionHandler(HttpMessageNotReadableException.class)
+    protected ResponseEntity<ErrorResponse> handleHttpMessageNotReadable(HttpMessageNotReadableException ex) {
+        log.warn("[HttpMessageNotReadable] message: {}", ex.getMessage());
+
+        Throwable cause = ex.getCause();
+        if (cause instanceof InvalidFormatException invalidEx) {
+            // LocalDate 파싱 실패인지 확인
+            if (invalidEx.getTargetType().equals(java.time.LocalDate.class)) {
+                return ResponseEntity
+                        .status(ErrorCode.INVALID_DATE_FORMAT.getStatus())
+                        .body(ErrorResponse.of(ErrorCode.INVALID_DATE_FORMAT));
+            }
+        }
+
+        return ResponseEntity
+                .status(ErrorCode.INVALID_REQUEST.getStatus())
+                .body(ErrorResponse.of(ErrorCode.INVALID_REQUEST, ex.getMessage()));
+    }
+
     @ExceptionHandler(MaxUploadSizeExceededException.class)
     protected ResponseEntity<ErrorResponse> handleMaxUploadSize(MaxUploadSizeExceededException maxUploadSizeExceededException) {
         log.error("[MaxUploadSizeExceeded] message: {}", maxUploadSizeExceededException.getMessage());
