Merge pull request #100 from Review-zip/dev

[Docs] Swagger 응답 작성

src/main/java/com/example/ReviewZIP/domain/post/PostsController.java

@@ -4,6 +4,8 @@
 import com.example.ReviewZIP.domain.post.dto.response.PostResponseDto;
 import com.example.ReviewZIP.global.response.ApiResponse;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.Parameters;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
@@ -30,10 +32,19 @@
 @RequestMapping("/v1/posts")
 public class PostsController {
     private final PostsService postsService;
-    private final PostsConverter postsConverter;
 
     // 특정 게시글의 정보 가져오기
     @GetMapping("/{postId}")
+    @Operation(summary = "특정 게시글의 정보 가져오기 API",description = "게시글의 id를 이용하여 상세정보 출력, UserInfoDto & ImageListDto & PostInfoDto 이용")
+    @ApiResponses({
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "POST401", description = "해당 게시물이 존재하지 않음",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+    })
+    @Parameters({
+            @Parameter(name = "postId", description = "게시글의 아이디"),
+            @Parameter(name = "page", description = "페이지 번호"),
+            @Parameter(name = "size", description = "페이징 사이즈")
+    })
     public ApiResponse<PostResponseDto.PostInfoDto> getPostInfo(@PathVariable(name = "postId") Long postId){
 
         PostResponseDto.PostInfoDto postInfoDto = postsService.getPostInfoDto(postId);
@@ -44,7 +55,7 @@ public ApiResponse<PostResponseDto.PostInfoDto> getPostInfo(@PathVariable(name =
     @PostMapping
     @Operation(summary = "게시글 생성", description = "PostRequestDto, CreatedPostResponseDto 사용")
     @ApiResponses({
-            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "SEARCH203",description = "OK, 성공"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
             @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "POST403", description = "게시글 작성 실패",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
     })
     public ApiResponse<PostResponseDto.CreatedPostResponseDto> createPost(@RequestBody PostRequestDto postRequestDto){
@@ -55,7 +66,7 @@ public ApiResponse<PostResponseDto.CreatedPostResponseDto> createPost(@RequestBo
     @GetMapping("/random")
     @Operation(summary = "랜덤으로 게시글 3개 가져오기", description = "PostInfoDto")
     @ApiResponses({
-            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "SEARCH203",description = "OK, 성공"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
             @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "POST405", description = "랜덤으로 게시글 3개 가져오기 실패",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
     })
     public ApiResponse<List<PostResponseDto.PostInfoDto>> getRandomPosts(@RequestParam Long userId) {

src/main/java/com/example/ReviewZIP/domain/user/UsersController.java

@@ -39,7 +39,7 @@ public ApiResponse<UserResponseDto.UserPreviewListDto> searchUsersByName(@Reques
     @GetMapping("/search/nickname")
     @Operation(summary = "닉네임으로 유저 검색 API",description = "유저의 닉네임으로 특정 유저를 검색 (자신이 팔로잉한 대상은 제외)")
     @ApiResponses({
-            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "SEARCH203",description = "OK, 성공"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
             @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER408", description = "유저를 찾을 수 없음",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
     })
     @Parameters({
@@ -53,8 +53,20 @@ public ApiResponse<UserResponseDto.UserPreviewListDto> searchUsersByNickname(@Re
         return ApiResponse.onSuccess(userListDto);
     }
 
+
     // 특정 유저의 팔로잉 목록 가져오기
     @GetMapping("{userId}/following")
+    @Operation(summary = "특정 유저의 팔로잉 목록 가져오기 API",description = "특정 유저의 id를 이용하여 해당 유저의 팔로잉 목록 조회, FollowerPreviewDto와 FollowerPreviewListDto 이용")
+    @ApiResponses({
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER404", description = "유저가 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER406", description = "팔로잉 목록이 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+    })
+    @Parameters({
+            @Parameter(name = "userId", description = "유저의 아이디"),
+            @Parameter(name = "page", description = "페이지 번호"),
+            @Parameter(name = "size", description = "페이징 사이즈")
+    })
     public ApiResponse<FollowResponseDto.FollowingPreviewListDto> getOtherFollowingList(@PathVariable(name = "userId") Long userId, @RequestParam(name = "page") Integer page, @RequestParam(name = "size")Integer size){
         Page<Follows> FollowsPage = usersService.getOtherFollowingList(userId, page, size);
 
@@ -63,14 +75,37 @@ public ApiResponse<FollowResponseDto.FollowingPreviewListDto> getOtherFollowingL
 
     // 특정 유저의 팔로워 목록 가져오기
     @GetMapping("/{userId}/followers")
+    @Operation(summary = "특정 유저의 팔로워 목록 가져오기 API",description = "특정 유저의 id를 이용하여 해당 유저의 팔로워 목록 조회, FollowingPreviewDto와 FollowingPreviewListDto 이용")
+    @ApiResponses({
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER404", description = "유저가 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "POST405", description = "팔로워 목록이 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+    })
+    @Parameters({
+            @Parameter(name = "userId", description = "유저의 아이디"),
+            @Parameter(name = "page", description = "페이지 번호"),
+            @Parameter(name = "size", description = "페이징 사이즈")
+    })
     public ApiResponse<FollowResponseDto.FollowerPreviewListDto> getOtherFollowerList(@PathVariable(name = "userId")Long userId, @RequestParam(name = "page") Integer page, @RequestParam(name = "size") Integer size){
         Page<Follows> FollowsPage = usersService.getOtherFollowerList(userId, page, size);
 
         return ApiResponse.onSuccess(UsersConverter.toFollowerPreviewListDto(FollowsPage));
     }
 
     // 특정 유저의 게시글들 가져오기
+
     @GetMapping("/{userId}/posts")
+    @Operation(summary = "특정 유저의 게시글 목록 가져오기 API",description = "특정 유저의 id를 받아 게시글들의 목록(대표 이미지들)을 반환, PostPreviewDto와 PostPreviewListDto 이용")
+    @ApiResponses({
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER404", description = "유저가 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "POST406", description = "게시글 목록이 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+    })
+    @Parameters({
+            @Parameter(name = "userId", description = "유저의 아이디"),
+            @Parameter(name = "page", description = "페이지 번호"),
+            @Parameter(name = "size", description = "페이징 사이즈")
+    })
     public ApiResponse<UserResponseDto.PostPreviewListDto> getOtherPostList(@PathVariable(name = "userId") Long userId
             , @RequestParam(name = "page") Integer page , @RequestParam(name = "size") Integer size){
         Page<Posts> UserPage = usersService.getOtherPostList(userId, page, size);
@@ -85,6 +120,17 @@ public ApiResponse<UserResponseDto.PostPreviewListDto> getOtherPostList(@PathVar
 
      // 특정 유저의 스크랩들 가져오기
      @GetMapping("/{userId}/posts/scrabs")
+     @Operation(summary = "특정 유저가 스크랩한 게시물 가져오기 API",description = "특정 유저의 id를 받아 스크랩한 게시글들의 목록(대표 이미지들)을 반환, PostPreviewDto와 PostPreviewListDto 이용")
+     @ApiResponses({
+             @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200",description = "OK, 성공"),
+             @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER404", description = "유저가 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+             @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "POST406", description = "게시글 목록이 존재하지 않습니다",content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+     })
+     @Parameters({
+             @Parameter(name = "userId", description = "유저의 아이디"),
+             @Parameter(name = "page", description = "페이지 번호"),
+             @Parameter(name = "size", description = "페이징 사이즈")
+     })
     public ApiResponse<UserResponseDto.PostPreviewListDto> getOtherScrabList(@PathVariable(name = "userId") Long userId, @RequestParam(name = "page")Integer page, @RequestParam(name = "size") Integer size){
         Page<Scrabs> UserPage = usersService.getOtherScrabList(userId,page, size);
 

src/main/java/com/example/ReviewZIP/domain/user/UsersService.java

@@ -9,6 +9,7 @@
 import com.example.ReviewZIP.domain.scrab.Scrabs;
 import com.example.ReviewZIP.domain.scrab.ScrabsRepository;
 import com.example.ReviewZIP.global.response.code.resultCode.ErrorStatus;
+import com.example.ReviewZIP.global.response.exception.handler.PostsHandler;
 import com.example.ReviewZIP.global.response.exception.handler.UsersHandler;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Page;
@@ -100,15 +101,19 @@ public Page<Follows> getOtherFollowerList(Long userId, Integer page, Integer siz
     public Page<Posts> getOtherPostList(Long userId, Integer page, Integer size){
         Users user = usersRepository.findById(userId).orElseThrow(()->new UsersHandler(ErrorStatus.USER_NOT_FOUND));
         Page<Posts> UserPage = postsRepository.findAllByUser(user, PageRequest.of(page, size));
-
+        if(UserPage.isEmpty()){
+            throw new PostsHandler(ErrorStatus.POST_LIST_NOT_FOUND);
+        }
         return UserPage;
     }
 
     @Transactional
     public Page<Scrabs> getOtherScrabList(Long userId, Integer page, Integer size){
         Users user = usersRepository.findById(userId).orElseThrow(()->new UsersHandler(ErrorStatus.USER_NOT_FOUND));
         Page<Scrabs> UserPage = scrabsRepository.findAllByUser(user, PageRequest.of(page, size));
-
+        if(UserPage.isEmpty()){
+            throw new PostsHandler(ErrorStatus.POST_LIST_NOT_FOUND);
+        }
         return UserPage;
     }
 }

src/main/java/com/example/ReviewZIP/domain/user/dto/response/UserResponseDto.java

@@ -1,14 +1,10 @@
 package com.example.ReviewZIP.domain.user.dto.response;
 
-import com.example.ReviewZIP.domain.user.Status;
-import jakarta.validation.constraints.NotBlank;
-import jakarta.validation.constraints.NotNull;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
-import java.time.LocalDate;
 import java.util.List;
 
 public class UserResponseDto {

src/main/java/com/example/ReviewZIP/global/response/code/resultCode/ErrorStatus.java

@@ -37,6 +37,7 @@ public enum ErrorStatus implements BaseErrorCode {
     POST_CREATE_FAIL(HttpStatus.BAD_REQUEST,"POST403", "게시글 작성에 실패하였습니다"),
     SCRAB_LIST_NOT_FOUND(HttpStatus.NOT_FOUND, "POST404", "스크랩 목록을 찾을 수 없습니다."),
     POST_RANDOM_FAIL(HttpStatus.BAD_REQUEST,"POST405", "사용자가 작성하지 않은 게시글이 최소 3개 이상 존재해야합니다."),
+    POST_LIST_NOT_FOUND(HttpStatus.NOT_FOUND, "POST406", "게시글 목록이 존재하지 않습니다."),
 
     // Hashtag
     HASHTAG_NOT_FOUND(HttpStatus.NOT_FOUND, "HASHTAG401", "존재하지 않는 해쉬태그입니다."),