[BE] docs: 작성한 리뷰 목록 조회, 회원용 리뷰 그룹 생성, 리뷰 그룹 정보, 리뷰 등록 API 문서를 작성한다.

backend/src/docs/asciidoc/create-review.adoc

@@ -1,6 +1,10 @@
-==== 리뷰 생성
+==== 비회원이 리뷰 생성
 
-operation::create-review[snippets="curl-request,request-fields,http-response"]
+operation::create-review-by-guest[snippets="curl-request,request-fields,http-response"]
+
+==== 회원이 리뷰 생성
+
+operation::create-review-by-member[snippets="curl-request,request-fields,http-response"]
 
 ==== 그룹 코드가 올바르지 않은 경우
 

backend/src/docs/asciidoc/review-list.adoc

@@ -1,3 +1,7 @@
 ==== 자신이 받은 리뷰 목록 조회
 
 operation::received-review-list-with-pagination[snippets="curl-request,request-cookies,query-parameters,http-response,response-fields"]
+
+==== 자신이 작성한 리뷰 목록 조회
+
+operation::written-review-list-with-pagination[snippets="curl-request,query-parameters,http-response,response-fields"]

backend/src/docs/asciidoc/reviewgroup.adoc

@@ -1,10 +1,18 @@
-==== 리뷰 그룹 생성
+==== 비회원용 리뷰 그룹 생성
 
-operation::review-group-create[snippets="curl-request,request-fields,http-response,response-fields"]
+operation::guest-review-group-create[snippets="curl-request,request-fields,http-response,response-fields"]
 
-==== 리뷰 그룹 간단 정보 조회
+==== 회원용 리뷰 그룹 생성
 
-operation::review-group-summary[snippets="curl-request,http-response,response-fields"]
+operation::member-review-group-create[snippets="curl-request,request-fields,http-response,response-fields"]
+
+==== 회원이 만든 리뷰 그룹 간단 정보 조회
+
+operation::member-review-group-summary[snippets="curl-request,http-response,response-fields"]
+
+==== 비회원이 만든 리뷰 그룹 간단 정보 조회
+
+operation::guest-review-group-summary[snippets="curl-request,http-response,response-fields"]
 
 ==== 리뷰 요청 코드, 확인 코드 일치 여부
 

backend/src/main/java/reviewme/review/controller/ReviewController.java

@@ -20,6 +20,7 @@
 import reviewme.review.service.dto.response.gathered.ReviewsGatheredBySectionResponse;
 import reviewme.review.service.dto.response.list.ReceivedReviewsResponse;
 import reviewme.review.service.dto.response.list.ReceivedReviewsSummaryResponse;
+import reviewme.review.service.dto.response.list.WrittenReviewsResponse;
 import reviewme.reviewgroup.controller.ReviewGroupSession;
 import reviewme.reviewgroup.domain.ReviewGroup;
 
@@ -35,6 +36,7 @@ public class ReviewController {
 
     @PostMapping("/v2/reviews")
     public ResponseEntity<Void> createReview(@Valid @RequestBody ReviewRegisterRequest request) {
+        // 회원 세션 추후 추가해야 함
         long savedReviewId = reviewRegisterService.registerReview(request);
         return ResponseEntity.created(URI.create("/reviews/" + savedReviewId)).build();
     }
@@ -75,4 +77,15 @@ public ResponseEntity<ReviewsGatheredBySectionResponse> getReceivedReviewsBySect
                 reviewGatheredLookupService.getReceivedReviewsBySectionId(reviewGroup, sectionId);
         return ResponseEntity.ok(response);
     }
+
+    @GetMapping("/v2/written")
+    public ResponseEntity<WrittenReviewsResponse> findWrittenReviews(
+            @RequestParam(required = false) Long lastReviewId,
+            @RequestParam(required = false) Integer size
+//            @MemberSession Member member
+            // TODO: 세션을 활용한 권한 체계에 따른 추가 조치 필요
+    ) {
+        WrittenReviewsResponse response = reviewListLookupService.getWrittenReviews(lastReviewId, size);
+        return ResponseEntity.ok(response);
+    }
 }

backend/src/main/java/reviewme/review/service/ReviewListLookupService.java

@@ -7,6 +7,7 @@
 import reviewme.review.repository.ReviewRepository;
 import reviewme.review.service.dto.response.list.ReceivedReviewsResponse;
 import reviewme.review.service.dto.response.list.ReviewListElementResponse;
+import reviewme.review.service.dto.response.list.WrittenReviewsResponse;
 import reviewme.review.service.mapper.ReviewListMapper;
 import reviewme.reviewgroup.domain.ReviewGroup;
 
@@ -29,6 +30,11 @@ public ReceivedReviewsResponse getReceivedReviews(Long lastReviewId, Integer siz
         );
     }
 
+    public WrittenReviewsResponse getWrittenReviews(Long lastReviewId, Integer size) {
+        // TODO: 생성일자 최신순 정렬
+        return null;
+    }
+
     private long calculateLastReviewId(List<ReviewListElementResponse> elements) {
         if (elements.isEmpty()) {
             return 0;

backend/src/main/java/reviewme/review/service/dto/response/list/WrittenReviewElementResponse.java

@@ -0,0 +1,14 @@
+package reviewme.review.service.dto.response.list;
+
+import java.time.LocalDate;
+import java.util.List;
+
+public record WrittenReviewElementResponse(
+        long reviewId,
+        String revieweeName,
+        String projectName,
+        LocalDate createdAt,
+        String contentPreview,
+        List<ReviewCategoryResponse> categories
+) {
+}

backend/src/main/java/reviewme/review/service/dto/response/list/WrittenReviewsResponse.java

@@ -0,0 +1,10 @@
+package reviewme.review.service.dto.response.list;
+
+import java.util.List;
+
+public record WrittenReviewsResponse(
+        List<WrittenReviewElementResponse> reviews,
+        long lastReviewId,
+        boolean isLastPage
+) {
+}

backend/src/main/java/reviewme/reviewgroup/controller/ReviewGroupController.java

@@ -34,6 +34,7 @@ public ResponseEntity<ReviewGroupResponse> getReviewGroupSummary(@RequestParam S
     public ResponseEntity<ReviewGroupCreationResponse> createReviewGroup(
             @Valid @RequestBody ReviewGroupCreationRequest request
     ) {
+        // 회원 세션 추후 추가해야 함
         ReviewGroupCreationResponse response = reviewGroupService.createReviewGroup(request);
         return ResponseEntity.ok(response);
     }

backend/src/main/java/reviewme/reviewgroup/service/ReviewGroupLookupService.java

@@ -19,6 +19,6 @@ public ReviewGroupResponse getReviewGroupSummary(String reviewRequestCode) {
         ReviewGroup reviewGroup = reviewGroupRepository.findByReviewRequestCode(reviewRequestCode)
                 .orElseThrow(() -> new ReviewGroupNotFoundByReviewRequestCodeException(reviewRequestCode));
 
-        return new ReviewGroupResponse(reviewGroup.getReviewee(), reviewGroup.getProjectName());
+        return new ReviewGroupResponse(null, reviewGroup.getReviewee(), reviewGroup.getProjectName());
     }
 }

backend/src/main/java/reviewme/reviewgroup/service/ReviewGroupService.java

@@ -3,13 +3,13 @@
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
-import reviewme.reviewgroup.service.exception.ReviewGroupNotFoundByReviewRequestCodeException;
-import reviewme.reviewgroup.service.exception.ReviewGroupUnauthorizedException;
 import reviewme.reviewgroup.domain.ReviewGroup;
 import reviewme.reviewgroup.repository.ReviewGroupRepository;
 import reviewme.reviewgroup.service.dto.CheckValidAccessRequest;
 import reviewme.reviewgroup.service.dto.ReviewGroupCreationRequest;
 import reviewme.reviewgroup.service.dto.ReviewGroupCreationResponse;
+import reviewme.reviewgroup.service.exception.ReviewGroupNotFoundByReviewRequestCodeException;
+import reviewme.reviewgroup.service.exception.ReviewGroupUnauthorizedException;
 import reviewme.template.domain.Template;
 import reviewme.template.repository.TemplateRepository;
 import reviewme.template.service.exception.TemplateNotFoundException;
@@ -27,6 +27,7 @@ public class ReviewGroupService {
 
     @Transactional
     public ReviewGroupCreationResponse createReviewGroup(ReviewGroupCreationRequest request) {
+        // 회원, 비회원 분기 처리 필요
         String reviewRequestCode;
         do {
             reviewRequestCode = randomCodeGenerator.generate(REVIEW_REQUEST_CODE_LENGTH);

backend/src/main/java/reviewme/reviewgroup/service/dto/MemberReviewGroupCreationRequest.java

@@ -0,0 +1,13 @@
+package reviewme.reviewgroup.service.dto;
+
+import jakarta.validation.constraints.NotEmpty;
+
+public record MemberReviewGroupCreationRequest(
+
+        @NotEmpty(message = "리뷰이 이름을 입력해주세요.")
+        String revieweeName,
+
+        @NotEmpty(message = "프로젝트 이름을 입력해주세요.")
+        String projectName
+) {
+}

backend/src/main/java/reviewme/reviewgroup/service/dto/ReviewGroupCreationRequest.java

@@ -1,6 +1,6 @@
 package reviewme.reviewgroup.service.dto;
 
-import jakarta.validation.constraints.NotBlank;
+import jakarta.annotation.Nullable;
 import jakarta.validation.constraints.NotEmpty;
 
 public record ReviewGroupCreationRequest(
@@ -11,7 +11,7 @@ public record ReviewGroupCreationRequest(
         @NotEmpty(message = "프로젝트 이름을 입력해주세요.")
         String projectName,
 
-        @NotBlank(message = "비밀번호를 입력해주세요.")
+        @Nullable
         String groupAccessCode
 ) {
 }

backend/src/main/java/reviewme/reviewgroup/service/dto/ReviewGroupResponse.java

@@ -1,7 +1,10 @@
 package reviewme.reviewgroup.service.dto;
 
+import jakarta.annotation.Nullable;
+
 public record ReviewGroupResponse(
 
+        @Nullable Long revieweeId,
         String revieweeName,
         String projectName
 ) {

backend/src/test/java/reviewme/api/ReviewApiTest.java

@@ -21,7 +21,6 @@
 import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;
 import org.springframework.restdocs.payload.FieldDescriptor;
 import org.springframework.restdocs.request.ParameterDescriptor;
-import reviewme.template.domain.QuestionType;
 import reviewme.review.service.dto.request.ReviewRegisterRequest;
 import reviewme.review.service.dto.response.gathered.HighlightResponse;
 import reviewme.review.service.dto.response.gathered.RangeResponse;
@@ -34,7 +33,10 @@
 import reviewme.review.service.dto.response.list.ReceivedReviewsSummaryResponse;
 import reviewme.review.service.dto.response.list.ReviewCategoryResponse;
 import reviewme.review.service.dto.response.list.ReviewListElementResponse;
+import reviewme.review.service.dto.response.list.WrittenReviewElementResponse;
+import reviewme.review.service.dto.response.list.WrittenReviewsResponse;
 import reviewme.reviewgroup.service.exception.ReviewGroupNotFoundByReviewRequestCodeException;
+import reviewme.template.domain.QuestionType;
 
 class ReviewApiTest extends ApiTest {
 
@@ -55,10 +57,41 @@ class ReviewApiTest extends ApiTest {
             """;
 
     @Test
-    void 리뷰를_등록한다() {
+    void 비회원이_리뷰를_등록한다() {
+        BDDMockito.given(reviewRegisterService.registerReview(any(ReviewRegisterRequest.class)))
+                .willReturn(1L);
+
+        FieldDescriptor[] requestFieldDescriptors = {
+                fieldWithPath("reviewRequestCode").description("리뷰 요청 코드"),
+
+                fieldWithPath("answers[]").description("답변 목록"),
+                fieldWithPath("answers[].questionId").description("질문 ID"),
+                fieldWithPath("answers[].selectedOptionIds").description("선택한 옵션 ID 목록").optional(),
+                fieldWithPath("answers[].text").description("서술 답변").optional()
+        };
+
+        RestDocumentationResultHandler handler = document(
+                "create-review-by-guest",
+                requestFields(requestFieldDescriptors)
+        );
+
+        givenWithSpec().log().all()
+                .body(request)
+                .when().post("/v2/reviews")
+                .then().log().all()
+                .apply(handler)
+                .statusCode(201);
+    }
+
+    @Test
+    void 회원이_리뷰를_등록한다() {
         BDDMockito.given(reviewRegisterService.registerReview(any(ReviewRegisterRequest.class)))
                 .willReturn(1L);
 
+        CookieDescriptor[] cookieDescriptors = {
+                cookieWithName("JSESSIONID").description("세션 ID")
+        };
+
         FieldDescriptor[] requestFieldDescriptors = {
                 fieldWithPath("reviewRequestCode").description("리뷰 요청 코드"),
 
@@ -69,11 +102,13 @@ class ReviewApiTest extends ApiTest {
         };
 
         RestDocumentationResultHandler handler = document(
-                "create-review",
+                "create-review-by-member",
+                requestCookies(cookieDescriptors),
                 requestFields(requestFieldDescriptors)
         );
 
         givenWithSpec().log().all()
+                .cookie("JSESSIONID", "ASVNE1VAKDNV4")
                 .body(request)
                 .when().post("/v2/reviews")
                 .then().log().all()
@@ -314,4 +349,59 @@ class ReviewApiTest extends ApiTest {
                 .apply(handler)
                 .statusCode(200);
     }
+
+    @Test
+    void 자신이_작성한_리뷰_목록을_조회한다() {
+        List<WrittenReviewElementResponse> writtenReviews = List.of(
+                new WrittenReviewElementResponse(1L, "테드1", "리뷰미", LocalDate.of(2024, 8, 2), "(리뷰 미리보기 1)",
+                        List.of(new ReviewCategoryResponse(1L, "카테고리 1"))),
+                new WrittenReviewElementResponse(2L, "테드2", "리뷰미", LocalDate.of(2024, 8, 1), "(리뷰 미리보기 2)",
+                        List.of(new ReviewCategoryResponse(2L, "카테고리 2")))
+        );
+        WrittenReviewsResponse response = new WrittenReviewsResponse(writtenReviews, 1L, true);
+        BDDMockito.given(reviewListLookupService.getWrittenReviews(anyLong(), anyInt()))
+                .willReturn(response);
+
+        CookieDescriptor[] cookieDescriptors = {
+                cookieWithName("JSESSIONID").description("세션 ID")
+        };
+
+        ParameterDescriptor[] queryParameter = {
+                parameterWithName("lastReviewId").description("페이지의 마지막 리뷰 ID - 기본으로 최신순 첫번째 페이지 응답"),
+                parameterWithName("size").description("페이지의 크기 - 기본으로 10개씩 응답")
+        };
+
+        FieldDescriptor[] responseFieldDescriptors = {
+                fieldWithPath("lastReviewId").description("페이지의 마지막 리뷰 ID"),
+                fieldWithPath("isLastPage").description("마지막 페이지 여부"),
+
+                fieldWithPath("reviews[]").description("리뷰 목록 (생성일 기준 내림차순 정렬)"),
+                fieldWithPath("reviews[].reviewId").description("리뷰 ID"),
+                fieldWithPath("reviews[].createdAt").description("리뷰 작성 날짜"),
+                fieldWithPath("reviews[].contentPreview").description("리뷰 미리보기"),
+                fieldWithPath("reviews[].revieweeName").description("리뷰이 이름"),
+                fieldWithPath("reviews[].projectName").description("프로젝트명"),
+
+                fieldWithPath("reviews[].categories[]").description("카테고리 목록"),
+                fieldWithPath("reviews[].categories[].optionId").description("카테고리 ID"),
+                fieldWithPath("reviews[].categories[].content").description("카테고리 내용")
+        };
+
+        RestDocumentationResultHandler handler = document(
+                "written-review-list-with-pagination",
+                requestCookies(cookieDescriptors),
+                queryParameters(queryParameter),
+                responseFields(responseFieldDescriptors)
+        );
+
+        givenWithSpec().log().all()
+                .cookie("JSESSIONID", "ASVNE1VAKDNV4")
+//                .queryParam("reviewRequestCode", "hello!!")
+                .queryParam("lastReviewId", "2")
+                .queryParam("size", "5")
+                .when().get("/v2/written")
+                .then().log().all()
+                .apply(handler)
+                .statusCode(200);
+    }
 }