[Fix] Swagger에 나타나는 설명을 수정했습니다.

inu-appcenter · Jan 18, 2024 · d4bff6c · d4bff6c
1 parent 739961b
commit d4bff6c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 7 deletions.
diff --git a/src/main/java/server/inuappcenter/kr/controller/IntroBoardController.java b/src/main/java/server/inuappcenter/kr/controller/IntroBoardController.java
@@ -37,7 +37,7 @@ public ResponseEntity<IntroBoardResponseDto> getBoard(final @PathVariable("id")
         IntroBoardResponseDto boardResponseDto = introBoardService.getIntroBoard(id);
         return ResponseEntity.status(HttpStatus.OK).body(boardResponseDto);
     }
-    @Operation(summary = "게시글 (1개) 저장하기", description = "1개의 사진이 필수적으로 필요합니다.")
+    @Operation(summary = "게시글 (1개) 저장하기", description = "게시글을 저장합니다. (첫번째 사진은 게시글의 썸네일로 사용됩니다.)")
     @PostMapping(consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
     public ResponseEntity<CommonResponseDto> saveBoard(final @ModelAttribute @Valid IntroBoardRequestDto introBoardRequestDto,
                                                                        BindingResult bindingResult) {
@@ -68,7 +68,7 @@ public ResponseEntity<List<IntroBoardResponseDto>> findAllBoard() {
     }
 
 
-    @Operation(summary = "게시글 수정 테스트")
+    @Operation(summary = "게시글 수정", description = "사진 수정(추가)이 있을 경우에는 경로에 /{photo_ids}를 포함해주세요")
     @PatchMapping(path = {"/{photo_ids}", "/"}, consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
     public ResponseEntity<CommonResponseDto> updateBoard(
             final @PathVariable(name = "photo_ids", required = false) List<Long> photo_ids,

diff --git a/src/main/java/server/inuappcenter/kr/controller/PhotoBoardController.java b/src/main/java/server/inuappcenter/kr/controller/PhotoBoardController.java
@@ -37,7 +37,7 @@ public ResponseEntity<PhotoBoardResponseDto> getBoard(final @PathVariable("id")
         return ResponseEntity.status(HttpStatus.OK).body(photoBoardResponseDto);
     }
 
-    @Operation(summary = "게시글 (1개) 저장하기", description = "1개의 사진이 필수적으로 필요합니다.")
+    @Operation(summary = "게시글 (1개) 저장하기", description = "게시글을 저장합니다. (첫번째 사진은 게시글의 썸네일로 사용됩니다.)")
     @PostMapping(consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
     public ResponseEntity<CommonResponseDto> saveBoard(final @ModelAttribute @Valid PhotoBoardRequestDto photoBoardRequestDto,
                                                                        BindingResult bindingResult) {
@@ -50,7 +50,7 @@ public ResponseEntity<CommonResponseDto> saveBoard(final @ModelAttribute @Valid
         }
     }
 
-    @Operation(summary = "게시글 수정 테스트")
+    @Operation(summary = "게시글 수정", description = "사진 수정(추가)이 있을 경우에는 경로에 /{photo_ids}를 포함해주세요")
     @PatchMapping(path = {"/{photo_ids}", "/"}, consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
     public ResponseEntity<CommonResponseDto> updateBoard(
             final @PathVariable(name = "photo_ids", required = false) List<Long> photo_ids,

diff --git a/src/test/java/server/inuappcenter/kr/HomepageApplicationTests.java b/src/test/java/server/inuappcenter/kr/HomepageApplicationTests.java
@@ -1,8 +1,5 @@
 package server.inuappcenter.kr;
 
-import org.junit.jupiter.api.Test;
-import org.springframework.boot.test.context.SpringBootTest;
-
 //@SpringBootTest
 class HomepageApplicationTests {