[FEAT] 프로젝트 매칭 요청 생성 API 작성, API 관련 Swagger 작성, 불필요한 에러코드 제거, 에러코드 관련…

… 오류메시지 샘플 작성
Open-Eye-Im-Developer · Feb 19, 2024 · 9fb72aa · 9fb72aa
1 parent 65d3d3b
commit 9fb72aa
Show file tree

Hide file tree

Showing 4 changed files with 100 additions and 3 deletions.
diff --git a/src/main/java/io/oeid/mogakgo/common/swagger/template/ProjectJoinRequestSwagger.java b/src/main/java/io/oeid/mogakgo/common/swagger/template/ProjectJoinRequestSwagger.java
@@ -0,0 +1,56 @@
+package io.oeid.mogakgo.common.swagger.template;
+
+import io.oeid.mogakgo.core.properties.swagger.error.SwaggerProjectErrorExamples;
+import io.oeid.mogakgo.core.properties.swagger.error.SwaggerProjectJoinRequestErrorExamples;
+import io.oeid.mogakgo.core.properties.swagger.error.SwaggerUserErrorExamples;
+import io.oeid.mogakgo.domain.project_join_req.application.dto.req.ProjectJoinCreateReq;
+import io.oeid.mogakgo.domain.project_join_req.presentation.dto.res.ProjectJoinRequestAPIRes;
+import io.oeid.mogakgo.exception.dto.ErrorResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.http.ResponseEntity;
+
+@Tag(name = "Project Join Request", description = "프로젝트 매칭 요청 관련 API")
+public interface ProjectJoinRequestSwagger {
+
+    @Operation(summary = "프로젝트 매칭 요청 생성", description = "회원이 프로젝트 매칭 요청을 생성할 때 사용하는 API")
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "201", description = "프로젝트 매칭 요청 생성 성공",
+            content = @Content(schema = @Schema(implementation = ProjectJoinRequestAPIRes.class))),
+        @ApiResponse(responseCode = "400", description = "요청한 데이터가 유효하지 않음",
+            content = @Content(
+                mediaType = "application/json",
+                schema = @Schema(implementation = ErrorResponse.class),
+                examples = {
+                    @ExampleObject(name = "E090101",
+                        value = SwaggerProjectJoinRequestErrorExamples.PROJECT_JOIN_REQUEST_ALREADY_EXIST),
+                    @ExampleObject(name = "E090103",
+                        value = SwaggerProjectJoinRequestErrorExamples.PROJECT_JOIN_REQUEST_INVALID_REGION)
+                })),
+        @ApiResponse(responseCode = "403", description = "프로젝트 매칭 요청 권한이 없음",
+            content = @Content(
+                mediaType = "application/json",
+                schema = @Schema(implementation = ErrorResponse.class),
+                examples = @ExampleObject(name = "E090201",
+                    value = SwaggerProjectJoinRequestErrorExamples.PROJECT_JOIN_REQUEST_FORBIDDEN_OPERATION))),
+        @ApiResponse(responseCode = "404", description = "요청한 데이터가 존재하지 않음",
+            content = @Content(
+                mediaType = "application/json",
+                schema = @Schema(implementation = ErrorResponse.class),
+                examples = {
+                    @ExampleObject(name = "E020301", value = SwaggerUserErrorExamples.USER_NOT_FOUND),
+                    @ExampleObject(name = "E030301", value = SwaggerProjectErrorExamples.PROJECT_NOT_FOUND)
+                })),
+    })
+    ResponseEntity<ProjectJoinRequestAPIRes> create(
+        @Parameter(hidden = true) Long userId,
+        ProjectJoinCreateReq request
+    );
+
+}
diff --git a/...io/oeid/mogakgo/core/properties/swagger/error/SwaggerProjectJoinRequestErrorExamples.java b/...io/oeid/mogakgo/core/properties/swagger/error/SwaggerProjectJoinRequestErrorExamples.java
@@ -0,0 +1,12 @@
+package io.oeid.mogakgo.core.properties.swagger.error;
+
+public class SwaggerProjectJoinRequestErrorExamples {
+
+    public static final String PROJECT_JOIN_REQUEST_ALREADY_EXIST = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":403,\"code\":\"E090201\",\"message\":\"프로젝트 생성자는 해당 프로젝트에 매칭 요청을 보낼 수 없습니다.\"}";
+    public static final String PROJECT_JOIN_REQUEST_FORBIDDEN_OPERATION = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":403,\"code\":\"E090101\",\"message\":\"이미 매칭 요청을 보낸 프로젝트에 매칭 요청을 보낼 수 없습니다..\"}";
+    public static final String PROJECT_JOIN_REQUEST_INVALID_REGION = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":403,\"code\":\"E090102\",\"message\":\"프로젝트 매칭 서비스는 동네 인증되지 않은 구역에서 진행할 수 없습니다..\"}";
+    private SwaggerProjectJoinRequestErrorExamples() {
+
+    }
+
+}
diff --git a/...va/io/oeid/mogakgo/domain/project_join_req/presentation/ProjectJoinRequestController.java b/...va/io/oeid/mogakgo/domain/project_join_req/presentation/ProjectJoinRequestController.java
@@ -0,0 +1,30 @@
+package io.oeid.mogakgo.domain.project_join_req.presentation;
+
+import io.oeid.mogakgo.common.annotation.UserId;
+import io.oeid.mogakgo.common.swagger.template.ProjectJoinRequestSwagger;
+import io.oeid.mogakgo.domain.project_join_req.application.ProjectJoinRequestService;
+import io.oeid.mogakgo.domain.project_join_req.application.dto.req.ProjectJoinCreateReq;
+import io.oeid.mogakgo.domain.project_join_req.presentation.dto.res.ProjectJoinRequestAPIRes;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/v1/project-join-request")
+@RequiredArgsConstructor
+public class ProjectJoinRequestController implements ProjectJoinRequestSwagger {
+
+    private final ProjectJoinRequestService projectJoinRequestService;
+
+    @PostMapping
+    public ResponseEntity<ProjectJoinRequestAPIRes> create(
+        @UserId Long userId, @Valid @RequestBody ProjectJoinCreateReq request
+    ) {
+        return ResponseEntity.status(201)
+            .body(ProjectJoinRequestAPIRes.from(projectJoinRequestService.create(userId, request)));
+    }
+}
diff --git a/src/main/java/io/oeid/mogakgo/exception/code/ErrorCode400.java b/src/main/java/io/oeid/mogakgo/exception/code/ErrorCode400.java
@@ -26,9 +26,8 @@ public enum ErrorCode400 implements ErrorCode {
     USERNAME_SHOULD_BE_NOT_EMPTY("E020103", "유저 이름은 비어있을 수 없습니다."),
     USER_REGION_SHOULD_BE_NOT_EMPTY("E020104", "유저 지역은 비어있을 수 없습니다."),
     USER_ID_NOT_NULL("E020001", "유저 아이디는 필수값입니다."),
-    INVALID_PROJECT_JOIN_REQUEST("E090101", "프로젝트 생성자는 프로젝트 매칭 요청을 생성할 수 없습니다."),
-    PROJECT_JOIN_REQUEST_ALREADY_EXIST("E090102", "이미 매칭 요청을 전송한 프로젝트에 매칭 요청을 생성할 수 없습니다."),
-    INVALID_PROJECT_JOIN_REQUEST_REGION("E090103", "동네 인증한 구역에서만 프로젝트 매칭 요청을 생성할 수 있습니다."),
+    PROJECT_JOIN_REQUEST_ALREADY_EXIST("E090101", "이미 매칭 요청을 전송한 프로젝트에 매칭 요청을 생성할 수 없습니다."),
+    INVALID_PROJECT_JOIN_REQUEST_REGION("E090102", "동네 인증한 구역에서만 프로젝트 매칭 요청을 생성할 수 있습니다."),
     ;
 
     private final HttpStatus httpStatus = HttpStatus.BAD_REQUEST;