|
| 1 | +package me.bombom.api.v1.challenge.controller; |
| 2 | + |
| 3 | +import io.swagger.v3.oas.annotations.Operation; |
| 4 | +import io.swagger.v3.oas.annotations.Parameter; |
| 5 | +import io.swagger.v3.oas.annotations.media.Content; |
| 6 | +import io.swagger.v3.oas.annotations.responses.ApiResponse; |
| 7 | +import io.swagger.v3.oas.annotations.responses.ApiResponses; |
| 8 | +import io.swagger.v3.oas.annotations.tags.Tag; |
| 9 | +import jakarta.validation.Valid; |
| 10 | +import jakarta.validation.constraints.Positive; |
| 11 | +import me.bombom.api.v1.challenge.dto.request.CreateChallengeReviewRequest; |
| 12 | +import me.bombom.api.v1.challenge.dto.request.UpdateChallengeReviewRequest; |
| 13 | +import me.bombom.api.v1.challenge.dto.response.ChallengeReviewResponse; |
| 14 | +import me.bombom.api.v1.challenge.dto.response.MyChallengeReviewResponse; |
| 15 | +import me.bombom.api.v1.common.resolver.LoginMember; |
| 16 | +import me.bombom.api.v1.member.domain.Member; |
| 17 | +import org.springframework.data.domain.Page; |
| 18 | +import org.springframework.data.domain.Pageable; |
| 19 | +import org.springframework.web.bind.annotation.PathVariable; |
| 20 | +import org.springframework.web.bind.annotation.RequestBody; |
| 21 | + |
| 22 | +@Tag(name = "Challenge Review", description = "챌린지 리뷰 관련 API") |
| 23 | +public interface ChallengeReviewControllerApi { |
| 24 | + |
| 25 | + @Operation( |
| 26 | + summary = "열람 가능한 리뷰 목록 조회", |
| 27 | + description = "로그인한 사용자가 직접 작성한 리뷰(비공개 포함)와 다른 사용자가 작성한 공개 리뷰 목록을 함께 조회합니다. " |
| 28 | + + "정렬은 항상 최신순으로 적용되며, `sort` 파라미터는 무시됩니다. " |
| 29 | + + "각 항목의 `isMyReview` 필드로 로그인 회원 본인 작성 여부를 분기 처리할 수 있습니다. " |
| 30 | + ) |
| 31 | + @ApiResponses({ |
| 32 | + @ApiResponse(responseCode = "200", description = "리뷰 목록 조회 성공"), |
| 33 | + @ApiResponse(responseCode = "401", description = "인증 실패 (로그인 필요)", content = @Content), |
| 34 | + @ApiResponse(responseCode = "404", description = "챌린지를 찾을 수 없음", content = @Content) |
| 35 | + }) |
| 36 | + Page<ChallengeReviewResponse> getReviews( |
| 37 | + @PathVariable @Positive(message = "challengeId는 1 이상의 값이어야 합니다.") Long challengeId, |
| 38 | + @Parameter(hidden = true) @LoginMember Member member, |
| 39 | + @Parameter(description = "페이징 요청 (예: ?page=0&size=20). 정렬은 항상 최신순으로 서버 강제이며 sort 파라미터는 무시됩니다.") Pageable pageable |
| 40 | + ); |
| 41 | + |
| 42 | + @Operation( |
| 43 | + summary = "내가 작성한 리뷰 조회", |
| 44 | + description = "로그인한 사용자가 해당 챌린지에 이미 작성한 리뷰가 있는지 확인합니다. " |
| 45 | + + "리뷰가 존재하면 200과 함께 리뷰 본문을 반환하고, 없으면 404를 반환합니다. " |
| 46 | + ) |
| 47 | + @ApiResponses({ |
| 48 | + @ApiResponse(responseCode = "200", description = "내 리뷰가 존재함"), |
| 49 | + @ApiResponse(responseCode = "401", description = "인증 실패 (로그인 필요)", content = @Content), |
| 50 | + @ApiResponse(responseCode = "404", description = "해당 챌린지에 작성한 리뷰가 없음", content = @Content) |
| 51 | + }) |
| 52 | + MyChallengeReviewResponse getMyReview( |
| 53 | + @PathVariable @Positive(message = "challengeId는 1 이상의 값이어야 합니다.") Long challengeId, |
| 54 | + @Parameter(hidden = true) @LoginMember Member member |
| 55 | + ); |
| 56 | + |
| 57 | + @Operation( |
| 58 | + summary = "리뷰 작성", |
| 59 | + description = "로그인한 사용자가 챌린지 리뷰를 작성합니다. 비공개 여부를 함께 지정할 수 있습니다. " |
| 60 | + + "본인이 참여한 챌린지에 대해서만 작성 가능하며, 비참여자 요청은 정보 누설 방지를 위해 404 로 응답합니다. " |
| 61 | + + "리뷰는 챌린지 마지막 날(종료일) 부터 작성 가능합니다. 종료일 당일 작성 시 출석 인정, 종료 후 작성은 리뷰만 저장됩니다." |
| 62 | + ) |
| 63 | + @ApiResponses({ |
| 64 | + @ApiResponse(responseCode = "201", description = "리뷰 작성 성공"), |
| 65 | + @ApiResponse( |
| 66 | + responseCode = "400", |
| 67 | + description = "잘못된 요청 (유효성 검증 실패 / 이미 작성한 리뷰 존재 / 챌린지 종료일 이전 — 리뷰는 마지막 날부터 작성 가능)", |
| 68 | + content = @Content |
| 69 | + ), |
| 70 | + @ApiResponse(responseCode = "401", description = "인증 실패 (로그인 필요)", content = @Content), |
| 71 | + @ApiResponse(responseCode = "404", description = "챌린지를 찾을 수 없음 또는 본인이 참여하지 않은 챌린지", content = @Content) |
| 72 | + }) |
| 73 | + void createReview( |
| 74 | + @PathVariable @Positive(message = "challengeId는 1 이상의 값이어야 합니다.") Long challengeId, |
| 75 | + @Valid @RequestBody CreateChallengeReviewRequest request, |
| 76 | + @Parameter(hidden = true) @LoginMember Member member |
| 77 | + ); |
| 78 | + |
| 79 | + @Operation( |
| 80 | + summary = "리뷰 수정", |
| 81 | + description = "로그인한 사용자가 자신의 챌린지 리뷰를 수정합니다. 코멘트와 비공개 여부를 함께 수정할 수 있습니다. " |
| 82 | + + "본인 리뷰만 수정 가능하며, 타인 리뷰에 대한 요청은 정보 누설 방지를 위해 404 로 응답합니다." |
| 83 | + ) |
| 84 | + @ApiResponses({ |
| 85 | + @ApiResponse(responseCode = "204", description = "리뷰 수정 성공"), |
| 86 | + @ApiResponse(responseCode = "400", description = "잘못된 요청 (유효성 검증 실패)", content = @Content), |
| 87 | + @ApiResponse(responseCode = "401", description = "인증 실패 (로그인 필요)", content = @Content), |
| 88 | + @ApiResponse(responseCode = "404", description = "리뷰를 찾을 수 없음 (미존재 / 경로의 챌린지 불일치 / 타인 리뷰 — IDOR 방어)", content = @Content) |
| 89 | + }) |
| 90 | + void updateReview( |
| 91 | + @PathVariable @Positive(message = "challengeId는 1 이상의 값이어야 합니다.") Long challengeId, |
| 92 | + @PathVariable @Positive(message = "reviewId는 1 이상의 값이어야 합니다.") Long reviewId, |
| 93 | + @Valid @RequestBody UpdateChallengeReviewRequest request, |
| 94 | + @Parameter(hidden = true) @LoginMember Member member |
| 95 | + ); |
| 96 | +} |
0 commit comments