Merge pull request #96 from TeamViewMore/feature/#93-restrict-phonenu…

…mber 📝 [DOCS] Swagger 추가 및 수정
TeamViewMore · Sep 20, 2024 · 78094c6 · 78094c6
2 parents c8ecf25 + ab4772b
commit 78094c6
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/src/main/java/com/viewmore/poksin/controller/EvidenceAPI.java b/src/main/java/com/viewmore/poksin/controller/EvidenceAPI.java
@@ -75,7 +75,16 @@ public ResponseEntity<ResponseDTO> createListFile(
                                     "{ \"status\": 200, \"code\": \"SUCCESS_RETRIEVE_MONTH_EVIDENCE\", \"message\": \"월별 증거를 성공적으로 조회했습니다.\",\n" +
                                             "\"data\": [\n" +
                                             "     {\n" +
-                                            "          \"evidenceCount\": 23\n" +
+                                            "          \"evidenceCount\": 2,\n" +
+                                            "          \"createdAt\": \"2024-09-11\"\n" +
+                                            "     },\n" +
+                                            "     {\n" +
+                                            "          \"evidenceCount\": 3,\n" +
+                                            "          \"createdAt\": \"2024-09-19\"\n" +
+                                            "     },\n" +
+                                            "     {\n" +
+                                            "          \"evidenceCount\": 1,\n" +
+                                            "          \"createdAt\": \"2024-09-20\"\n" +
                                             "     }\n" +
                                             "]\n" +
                                             "}"))),

diff --git a/src/main/java/com/viewmore/poksin/controller/UserAPI.java b/src/main/java/com/viewmore/poksin/controller/UserAPI.java
@@ -29,6 +29,16 @@ public interface UserAPI {
                             schema = @Schema(implementation = ResponseDTO.class),
                             examples = @ExampleObject(value = "{ \"status\": 201, \"code\": \"SUCCESS_REGISTER\", \"message\": \"회원가입을 성공했습니다.\", \"data\": null }"))),
 
+
+            @ApiResponse(responseCode = "400", description = "잘못된 요청을 보냈을 경우 (예: 전화번호 형식 오류 또는 긴급 연락처 형식 오류)",
+                    content = @Content(mediaType = "application/json",
+                            schema = @Schema(implementation = ErrorResponseDTO.class),
+                            examples = {
+                                    @ExampleObject(name = "Invalid Phone Number", value = "{ \"status\": 400, \"code\": \"BAD_REQUEST\", \"message\": \"잘못된 요청입니다.\", \"errors\": { \"phoneNum\": \"전화번호는 11개의 숫자로만 구성되어야 합니다.\" } }"),
+                                    @ExampleObject(name = "Invalid Emergency Number", value = "{ \"status\": 400, \"code\": \"BAD_REQUEST\", \"message\": \"잘못된 요청입니다.\", \"errors\": { \"emergencyNum\": \"긴급 연락처는 11개의 숫자로만 구성되어야 합니다.\" } }"),
+                                    @ExampleObject(name = "Invalid Phone and Emergency Numbers", value = "{ \"status\": 400, \"code\": \"BAD_REQUEST\", \"message\": \"잘못된 요청입니다.\", \"errors\": { \"phoneNum\": \"전화번호는 11개의 숫자로만 구성되어야 합니다.\", \"emergencyNum\": \"긴급 연락처는 11개의 숫자로만 구성되어야 합니다.\" } }")
+                            })),
+
             @ApiResponse(responseCode = "409", description = "데이베이스에 존재하는 아이디로 아이디를 생성하고자 할 경우",
                     content = @Content(mediaType = "application/json",
                             schema = @Schema(implementation = ErrorResponseDTO.class),
@@ -70,6 +80,14 @@ public interface UserAPI {
                             examples = @ExampleObject(value =
                                     "{ \"status\": 200, \"code\": \"SUCCESS_UPDATE_USER\", \"message\": \"유저 정보를 성공적으로 수정했습니다.\", \"data\": { \"username\": \"poksin\", \"phoneNum\": \"010-1234-5678\", \"emergencyNum\": \"010-1111-2222\", \"address\": \"null\", \"role\": \"ROLE_USER\", \"createdAt\": \"2024-07-30T20:32:10.441113\" } }"))),
 
+            @ApiResponse(responseCode = "400", description = "잘못된 요청을 보냈을 경우 (예: 전화번호 형식 오류 또는 긴급 연락처 형식 오류)",
+                    content = @Content(mediaType = "application/json",
+                            schema = @Schema(implementation = ErrorResponseDTO.class),
+                            examples = {
+                                    @ExampleObject(name = "Invalid Phone Number", value = "{ \"status\": 400, \"code\": \"BAD_REQUEST\", \"message\": \"잘못된 요청입니다.\", \"errors\": { \"phoneNum\": \"전화번호는 11개의 숫자로만 구성되어야 합니다.\" } }"),
+                                    @ExampleObject(name = "Invalid Emergency Number", value = "{ \"status\": 400, \"code\": \"BAD_REQUEST\", \"message\": \"잘못된 요청입니다.\", \"errors\": { \"emergencyNum\": \"긴급 연락처는 11개의 숫자로만 구성되어야 합니다.\" } }"),
+                                    @ExampleObject(name = "Invalid Phone and Emergency Numbers", value = "{ \"status\": 400, \"code\": \"BAD_REQUEST\", \"message\": \"잘못된 요청입니다.\", \"errors\": { \"phoneNum\": \"전화번호는 11개의 숫자로만 구성되어야 합니다.\", \"emergencyNum\": \"긴급 연락처는 11개의 숫자로만 구성되어야 합니다.\" } }")
+                            })),
             @ApiResponse(responseCode = "401", description = "잘못된 토큰으로 요청할 경우",
                     content = @Content(mediaType = "application/json",
                             schema = @Schema(implementation = ErrorResponseDTO.class),