Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
344 changes: 344 additions & 0 deletions docs/specs/024-review-course-issue.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/specs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@
| [지도 마커 클러스터링](021-marker-clustering.md) | 검색 한 번에 확대 단계별 묶음(서버 고정 그리드)·확대·축소는 앱이 단계 선택·탭 확대 범위·유형 필터(practiceTypes)·좌표 API deprecated | Implemented |
| [레벨별 연습 기록](022-level-practice-record.md) | 연습 기록을 (회원, 장소, 레벨)마다 저장·레벨별 목록 조회(019에서 분리, 추후 구현) | Deferred |
| [Pi 개발 서버 배포](023-pi-dev-server-deploy.md) | develop→pi2(ARM64·Tailscale OIDC+SSH)/main→Lightsail 분리·`dev` 프로필·pi2 compose·내부 API `@DevOnly` 게이팅·자동 롤백·Cloudflare Tunnel(`dev-api`) | Implemented |
| [후기 코스 문제 항목 · 후기 작성 폼](024-review-course-issue.md) | 별로에요 선택 시 난이도·혼잡도 대신 코스 문제 항목(복수·기타 30자) 입력·저장만(노출 없음) · 후기 작성 화면 전체 폼(`/places/{placeId}/review-form`) | Implemented |
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import cmc.rodi.domain.review.dto.MyReviewItem;
import cmc.rodi.domain.review.dto.ReviewCreateResponse;
import cmc.rodi.domain.review.dto.ReviewDetailResponse;
import cmc.rodi.domain.review.dto.ReviewFormResponse;
import cmc.rodi.domain.review.dto.ReviewItem;
import cmc.rodi.domain.review.dto.ReviewListRequest;
import cmc.rodi.domain.review.dto.ReviewReportRequest;
Expand Down Expand Up @@ -53,6 +54,12 @@ public ApiResponse<ReviewCreateResponse> createReview(
return ApiResponse.success(reviewService.create(placeId, memberId, request));
}

@Override
@GetMapping("/places/{placeId}/review-form")
public ApiResponse<ReviewFormResponse> getReviewForm(@PathVariable Long placeId) {
return ApiResponse.success(reviewService.getReviewForm(placeId));
}

@Override
@GetMapping("/members/me/reviews")
public ApiResponse<CursorPage<MyReviewItem>> getMyReviews(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import cmc.rodi.domain.review.dto.MyReviewItem;
import cmc.rodi.domain.review.dto.ReviewCreateResponse;
import cmc.rodi.domain.review.dto.ReviewDetailResponse;
import cmc.rodi.domain.review.dto.ReviewFormResponse;
import cmc.rodi.domain.review.dto.ReviewItem;
import cmc.rodi.domain.review.dto.ReviewReportRequest;
import cmc.rodi.domain.review.dto.ReviewRequest;
Expand Down Expand Up @@ -48,12 +49,26 @@ public interface ReviewControllerDocs {
}
""";

@Operation(
summary = "후기 작성 폼 조회",
description =
"후기 작성·수정 화면 정의를 반환한다. 단계(steps) → 문항(questions) → 선택지(options) 구조이고, 문항 code는"
+ " 작성 요청의 필드명, 선택지 code는 제출 값이다(추천 여부는 \"true\"/\"false\" 문자열 → boolean으로 제출)."
+ " 1단계 제목에 코스명이 들어가며 placeName으로 따로도 준다."
+ " 흐름 규칙: 기본 선택값이 없어 처음엔 추천 여부만 보이고, showWhen 문항은 조건 선택지를 골랐을 때만 노출된다"
+ "(추천해요 → 난이도·혼잡도·주의사항, 별로에요 → 코스 문제 항목). 숨겨진 문항은 required여도 입력하지 않는다."
+ " 코스 문제 항목의 OTHER(기타)는 requiresTextInput=true이며 입력값은 courseIssueDetail로 보낸다."
+ " 수정 화면 값은 후기 상세로 채운다. 없는 장소면 404. JWT 필요.")
ApiResponse<ReviewFormResponse> getReviewForm(@Parameter(description = "장소 id") Long placeId);

@Operation(
summary = "후기 작성",
description =
"장소(코스·주차장)에 후기를 남긴다. 작성 당시 회원 레벨을 서버가 스냅샷으로 저장하며, 같은 장소에 여러 번 쓸 수 있다."
+ " 필수는 isRecommended·difficulty·congestion·practiceMethod 넷이고"
+ " content·caution은 선택이라 글 없이 평가만 남길 수 있다(공백만 보내면 없는 것으로 저장)."
+ " 1단계 평가는 추천 여부에 따라 갈린다 — 추천해요(true)는 difficulty·congestion 필수(caution 선택),"
+ " 별로에요(false)는 courseIssues 1개 이상 필수(OTHER를 고르면 courseIssueDetail 필수, 30자 이하)."
+ " 반대쪽 값은 에러 없이 무시한다. practiceMethod는 항상 필수이고"
+ " content는 선택이라 글 없이 평가만 남길 수 있다(공백만 보내면 없는 것으로 저장)."
+ " 레벨이 없는 회원(온보딩 미완료)은 409. JWT 필요.")
ApiResponse<ReviewCreateResponse> createReview(
@Parameter(description = "장소 id") Long placeId,
Expand Down Expand Up @@ -103,7 +118,9 @@ ApiResponse<CursorPage<ReviewItem>> getReviews(
description =
"난이도 분포와 최다 난이도(topDifficulty)는 **선택한 레벨** 기준, 추천/비추천 수는 **전체 레벨 합산**이라"
+ " 모수가 levelReviewCount·totalReviewCount로 나뉜다. 동률이면 더 어려운 난이도를 고르고,"
+ " 후기가 없으면 topDifficulty 키 자체가 빠진다. 드롭다운용 레벨별 후기 수도 함께 준다."
+ " 난이도를 표시한 후기가 없으면 topDifficulty 키 자체가 빠진다. levelReviewCount는 난이도를 표시한 후기만 세"
+ " difficultyCounts 합계와 같다(별로에요 후기는 난이도가 없어 빠진다). 드롭다운용 레벨별 후기 수(levelCounts)는"
+ " 모든 후기를 센다."
+ " 집계 단위는 후기 건수이며 차단은 반영하지 않는다. JWT 필요.")
ApiResponse<ReviewSummaryResponse> getSummary(
@Parameter(description = "장소 id") Long placeId,
Expand All @@ -129,16 +146,18 @@ ApiResponse<ReviewSummaryResponse> getSummary(
"후기 한 건의 전체 값을 준다. 수정 화면이 폼을 채우는 용도라 수정 요청(PUT)이 요구하는 필드를 모두 담는다."
+ " 목록에 없는 caution까지 주므로 본인 후기만 조회할 수 있다(타인 403)."
+ " 신고 누적으로 비공개된 내 후기도 조회되며 isHidden=true로 온다."
+ " 내용이 없는 후기는 content가 null이다. 없는 후기는 404. JWT 필요.")
+ " 내용이 없는 후기는 content가 null이다. 별로에요 후기는 difficulty·congestion이 null이고"
+ " courseIssues(폼 order 순)·courseIssueDetail이 채워진다(추천해요 후기는 courseIssues=[])."
+ " 없는 후기는 404. JWT 필요.")
ApiResponse<ReviewDetailResponse> getReview(
@Parameter(description = "후기 id") Long reviewId,
@Parameter(hidden = true) Long memberId);

@Operation(
summary = "후기 수정",
description =
"본인 후기를 전체 교체한다. 작성과 같은 바디를 쓰며, 전체 교체라 content·caution을 비워 보내면"
+ " 기존 값이 지워진다. 작성 당시 레벨과 현재 레벨이 다르면 409, 타인 후기면 403. JWT 필요.")
"본인 후기를 전체 교체한다. 작성과 같은 바디·검증을 쓰며, 전체 교체라 content·caution을 비워 보내면"
+ " 기존 값이 지워진다. 추천↔비추천을 바꾸면 반대쪽 평가 값(난이도·혼잡도·주의사항 또는 코스 문제 항목)이 지워진다. 작성 당시 레벨과 현재 레벨이 다르면 409, 타인 후기면 403. JWT 필요.")
ApiResponse<Void> updateReview(
@Parameter(description = "후기 id") Long reviewId,
@Parameter(hidden = true) Long memberId,
Expand Down
17 changes: 15 additions & 2 deletions src/main/java/cmc/rodi/domain/review/dto/ReviewDetailResponse.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

import cmc.rodi.domain.member.entity.Level;
import cmc.rodi.domain.review.entity.Congestion;
import cmc.rodi.domain.review.entity.CourseIssue;
import cmc.rodi.domain.review.entity.Difficulty;
import cmc.rodi.domain.review.entity.PracticeMethod;
import cmc.rodi.domain.review.entity.Review;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import java.time.LocalDateTime;
import java.util.Comparator;
import java.util.List;

/**
* 후기 한 건의 전체 값. <b>수정 화면이 폼을 채우는 데 쓴다</b> — 그래서 목록 아이템과 달리 수정 요청({@code ReviewRequest})이 요구하는 필드를
Expand All @@ -22,8 +25,10 @@ public record ReviewDetailResponse(
@Schema(description = "후기를 쓴 장소 id") Long placeId,
@Schema(description = "장소명(수정 화면 헤더용)") String placeName,
@Schema(description = "추천 여부") @JsonProperty("isRecommended") boolean recommended,
@Schema(description = "체감 난이도") Difficulty difficulty,
@Schema(description = "혼잡도") Congestion congestion,
@Schema(description = "체감 난이도(별로에요 후기는 null일 수 있다)") Difficulty difficulty,
@Schema(description = "혼잡도(별로에요 후기는 null일 수 있다)") Congestion congestion,
@Schema(description = "코스 문제 항목(폼 order 순, 추천해요 후기는 빈 배열)") List<CourseIssue> courseIssues,
@Schema(description = "코스 문제 기타 직접 입력(없으면 null)") String courseIssueDetail,
@Schema(description = "연습 방법") PracticeMethod practiceMethod,
@Schema(description = "후기 내용(없으면 null)") String content,
@Schema(description = "주의사항(없으면 null)") String caution,
Expand All @@ -34,6 +39,10 @@ public record ReviewDetailResponse(
boolean verifiedVisit,
@Schema(description = "작성 시각") LocalDateTime createdAt) {

/**
* 후기 엔티티를 상세 응답으로 바꾼다. 코스 문제 항목은 폼과 같은 order 순으로 정렬해 수정 화면이 그대로 채울 수 있게 하고, 수정 가능 여부는 조회자의 현재
* 레벨로 판정한다.
*/
public static ReviewDetailResponse of(Review review, Level currentLevel) {
return new ReviewDetailResponse(
review.getId(),
Expand All @@ -42,6 +51,10 @@ public static ReviewDetailResponse of(Review review, Level currentLevel) {
review.isRecommended(),
review.getDifficulty(),
review.getCongestion(),
review.getCourseIssues().stream()
.sorted(Comparator.comparingInt(CourseIssue::getOrder))
.toList(),
review.getCourseIssueDetail(),
review.getPracticeMethod(),
review.getContent(),
review.getCaution(),
Expand Down
Loading
Loading