From c29dc897cdbb15e932de36b78319ea6f1df1350b Mon Sep 17 00:00:00 2001 From: Moojun Date: Mon, 16 Oct 2023 03:14:43 +0900 Subject: [PATCH] =?UTF-8?q?#27=20-=20chore:=20swagger=20=EB=AC=B8=EC=84=9C?= =?UTF-8?q?=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../community/controller/PostController.java | 2 ++ .../post/delete/delete_BAD_REQUEST.java | 31 +++++++++++++++++++ .../post/save/save_BAD_REQUEST.java | 8 ++--- .../post/update/update_BAD_REQUEST.java | 21 ++++++------- 4 files changed, 47 insertions(+), 15 deletions(-) create mode 100644 src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/delete/delete_BAD_REQUEST.java diff --git a/src/main/java/org/ai/roboadvisor/domain/community/controller/PostController.java b/src/main/java/org/ai/roboadvisor/domain/community/controller/PostController.java index b0ba2f0..9c88b66 100644 --- a/src/main/java/org/ai/roboadvisor/domain/community/controller/PostController.java +++ b/src/main/java/org/ai/roboadvisor/domain/community/controller/PostController.java @@ -9,6 +9,7 @@ import org.ai.roboadvisor.domain.community.dto.response.PostDeleteResponse; import org.ai.roboadvisor.domain.community.dto.response.PostResponse; import org.ai.roboadvisor.domain.community.service.PostService; +import org.ai.roboadvisor.domain.community.swagger_annotation.post.delete.delete_BAD_REQUEST; import org.ai.roboadvisor.domain.community.swagger_annotation.post.delete.delete_OK; import org.ai.roboadvisor.domain.community.swagger_annotation.post.delete.delete_UNAUTHORIZED; import org.ai.roboadvisor.domain.community.swagger_annotation.post.getPostById.getPostById_BAD_REQUEST; @@ -81,6 +82,7 @@ public ResponseEntity> update(@PathVariable("po Swagger 문서 하단의 Schemas 중 RequestBody로 'PostDeleteRequest' 를 사용한다. """) @delete_OK + @delete_BAD_REQUEST @delete_UNAUTHORIZED @ApiResponse_Internal_Server_Error @DeleteMapping("/{postId}") diff --git a/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/delete/delete_BAD_REQUEST.java b/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/delete/delete_BAD_REQUEST.java new file mode 100644 index 0000000..6167f22 --- /dev/null +++ b/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/delete/delete_BAD_REQUEST.java @@ -0,0 +1,31 @@ +package org.ai.roboadvisor.domain.community.swagger_annotation.post.delete; + +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 org.ai.roboadvisor.global.common.dto.SuccessApiResponse; + +import java.lang.annotation.*; + +@Target({ElementType.METHOD}) +@Retention(RetentionPolicy.RUNTIME) +@Inherited +@ApiResponse(responseCode = "400", description = "게시글 번호가 잘못 입력된 경우, 혹은 존재하지 않는 경우", + content = @Content(schema = @Schema(implementation = SuccessApiResponse.class), + examples = + @ExampleObject(name = "example", + description = "게시글 번호가 잘못 입력된 경우, 혹은 존재하지 않는 경우 예시", + value = """ + { + "code": 400, + "message": "요청하신 게시글 id가 존재하지 않습니다.", + "data": null + } + """ + ) + + )) +public @interface delete_BAD_REQUEST { +} + diff --git a/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/save/save_BAD_REQUEST.java b/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/save/save_BAD_REQUEST.java index a822faa..520474e 100644 --- a/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/save/save_BAD_REQUEST.java +++ b/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/save/save_BAD_REQUEST.java @@ -12,17 +12,17 @@ @Retention(RetentionPolicy.RUNTIME) @Inherited @ApiResponse(responseCode = "400", description = """ - 투자 성향이 LION(공격투자형), SNAKE(적극투자형), MONKEY(위험중립형), SHEEP(안정추구형) 외에 다른 값이 들어온 경우, + PostRequest 요청으로 입력된 사용자의 닉네임 정보가 db에 존재하지 않는 경우. - 즉, 존재하지 않는 투자 성향이 입력된 경우 + 즉, 사용자가 존재하지 않는 경우 """, content = @Content(schema = @Schema(implementation = SuccessApiResponse.class), examples = @ExampleObject(name = "example", - description = "투자 성향이 잘못 입력된 경우 예시", + description = "사용자가 존재하지 않는 경우 예시", value = """ { "code": 400, - "message": "잘못된 투자 성향 형식이 입력되었습니다", + "message": "가입된 사용자의 정보가 존재하지 않습니다", "data": null } """ diff --git a/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/update/update_BAD_REQUEST.java b/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/update/update_BAD_REQUEST.java index 90d93ef..863f965 100644 --- a/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/update/update_BAD_REQUEST.java +++ b/src/main/java/org/ai/roboadvisor/domain/community/swagger_annotation/post/update/update_BAD_REQUEST.java @@ -11,22 +11,21 @@ @Target({ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Inherited -@ApiResponse(responseCode = "400", description = """ - 투자 성향이 LION(공격투자형), SNAKE(적극투자형), MONKEY(위험중립형), SHEEP(안정추구형) 외에 다른 값이 들어온 경우, - - 즉, 존재하지 않는 투자 성향이 입력된 경우 - """, +@ApiResponse(responseCode = "400", description = "게시글 번호가 잘못 입력된 경우, 혹은 존재하지 않는 경우", content = @Content(schema = @Schema(implementation = SuccessApiResponse.class), - examples = @ExampleObject(name = "example", - description = "투자 성향이 잘못 입력된 경우 예시", + examples = + @ExampleObject(name = "example", + description = "게시글 번호가 잘못 입력된 경우, 혹은 존재하지 않는 경우 예시", value = """ { - "code": 400, - "message": "잘못된 투자 성향 형식이 입력되었습니다", - "data": null + "code": 400, + "message": "요청하신 게시글 id가 존재하지 않습니다.", + "data": null } """ - ))) + ) + + )) public @interface update_BAD_REQUEST { }