Merge pull request #77 from YAPP-Github/feat/T3-198

[T3-198] 전체 제보 목록 조회 API

Author: yuseok0215

src/main/java/bitnagil/bitnagil_backend/file/controller/FileController.java

@@ -12,7 +12,7 @@
 
 @RestController
 @RequiredArgsConstructor
-@RequestMapping(value = "/api/v2/file")
+@RequestMapping(value = "/api/v2/files")
 public class FileController implements FileSpec {
     private final FileService fileService;
 

src/main/java/bitnagil/bitnagil_backend/report/controller/ReportController.java

@@ -4,18 +4,18 @@
 import bitnagil.bitnagil_backend.global.response.CustomResponseDto;
 import bitnagil.bitnagil_backend.report.controller.spec.ReportSpec;
 import bitnagil.bitnagil_backend.report.request.ReportRegisterRequest;
+import bitnagil.bitnagil_backend.report.response.ReportInfoResponse;
 import bitnagil.bitnagil_backend.report.service.ReportService;
 import bitnagil.bitnagil_backend.user.domain.User;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import lombok.RequiredArgsConstructor;
-import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.*;
-import org.springframework.web.multipart.MultipartFile;
-
-import java.util.List;
 
 @RestController
 @RequiredArgsConstructor
-@RequestMapping(value = "/api/v2/report")
+@RequestMapping(value = "/api/v2/reports")
 public class ReportController implements ReportSpec {
 
     private final ReportService reportService;
@@ -27,6 +27,12 @@ public CustomResponseDto<Long> registerReport(@CurrentUser User user,
         return CustomResponseDto.from(reportService.registerReport(user, request));
     }
 
+    // 제보 목록 조회 API
+    @GetMapping()
+    public CustomResponseDto<ReportInfoResponse> getAllReportInfo(@CurrentUser User user) {
+        return CustomResponseDto.from(reportService.getAllReportInfo(user));
+    }
+
     /* 추후에 변경을 고려해서 소스만 남겨놓음
     // 제보 파일 저장 API
     @PutMapping(value = "/{reportId}/images")

src/main/java/bitnagil/bitnagil_backend/report/controller/spec/ReportSpec.java

@@ -1,22 +1,36 @@
 package bitnagil.bitnagil_backend.report.controller.spec;
 
+import bitnagil.bitnagil_backend.global.annotation.CurrentUser;
 import bitnagil.bitnagil_backend.global.response.CustomResponseDto;
 import bitnagil.bitnagil_backend.global.swagger.ApiTags;
 import bitnagil.bitnagil_backend.report.request.ReportRegisterRequest;
+import bitnagil.bitnagil_backend.report.response.ReportInfoResponse;
 import bitnagil.bitnagil_backend.user.domain.User;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
+
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 
 import java.util.List;
 
 @Tag(name = ApiTags.REPORT)
 public interface ReportSpec {
 
+    @ApiResponse(responseCode = "200", useReturnTypeSchema = true, content =
+        @Content(mediaType = "application/json", examples = @ExampleObject(name = "성공 예시", value =
+            "{\n \"code\": \"OK\",\n \"message\": \"등록되었습니다.\",\n \"data\": 1\n}")))
     @Operation(summary = "제보등록",
             description = "회원이 제보를 등록합니다.")
     CustomResponseDto<Long> registerReport(User user, @RequestBody ReportRegisterRequest request);
 
+    @Operation(summary = "전체 제보 목록 조회",
+        description = "전체 제보 목록을 조회합니다.")
+    CustomResponseDto<ReportInfoResponse> getAllReportInfo(@CurrentUser User user);
+
     /* 추후에 변경을 고려해서 소스만 남겨놓음
     @Operation(summary = "제보 이미지 등록",
             description = "presigned URL을 통해 업로드된 이미지들의 URL을 제보 이미지로 등록합니다.")

src/main/java/bitnagil/bitnagil_backend/report/domain/Report.java

@@ -3,6 +3,7 @@
 import bitnagil.bitnagil_backend.global.entity.BaseTimeEntity;
 import bitnagil.bitnagil_backend.global.utils.StringListConverter;
 import bitnagil.bitnagil_backend.report.domain.enums.ReportCategory;
+import bitnagil.bitnagil_backend.report.domain.enums.ReportStatus;
 import bitnagil.bitnagil_backend.routineInfoV2.domain.RoutineInfoV2;
 import bitnagil.bitnagil_backend.user.domain.User;
 import jakarta.persistence.*;
@@ -31,6 +32,10 @@ public class Report extends BaseTimeEntity {
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long reportId; // 제보ID
 
+    @Enumerated(EnumType.STRING)
+    @Column(columnDefinition = "varchar(40)")
+    private ReportStatus reportStatus; // 제보 처리 상태
+
     @Enumerated(EnumType.STRING)
     @Column(columnDefinition = "varchar(40)")
     private ReportCategory reportCategory; // 제보카테고리
@@ -55,8 +60,10 @@ public class Report extends BaseTimeEntity {
     private User user;
 
     @Builder
-    public Report(ReportCategory reportCategory, List<String> reportImageUrls, String reportTitle, String reportContent,
-                  String reportLocation, BigDecimal latitude, BigDecimal longitude, User user) {
+    public Report(ReportStatus reportStatus, ReportCategory reportCategory, List<String> reportImageUrls,
+        String reportTitle, String reportContent, String reportLocation, BigDecimal latitude, BigDecimal longitude,
+        User user) {
+        this.reportStatus = reportStatus;
         this.reportCategory = reportCategory;
         this.reportImageUrls = reportImageUrls;
         this.reportTitle = reportTitle;

src/main/java/bitnagil/bitnagil_backend/report/domain/enums/ReportStatus.java

@@ -0,0 +1,16 @@
+package bitnagil.bitnagil_backend.report.domain.enums;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public enum ReportStatus {
+
+    PENDING("제보 완료"),
+    IN_PROGRESS("처리 중"),
+    COMPLETED("처리 완료");
+
+
+    private final String description;
+}

src/main/java/bitnagil/bitnagil_backend/report/repository/ReportRepository.java

@@ -1,9 +1,15 @@
 package bitnagil.bitnagil_backend.report.repository;
 
+import java.util.List;
+
 import bitnagil.bitnagil_backend.report.domain.Report;
+import bitnagil.bitnagil_backend.user.domain.User;
+
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
 @Repository
 public interface ReportRepository extends JpaRepository<Report, Long> {
+
+    List<Report> findByUser(User user);
 }

src/main/java/bitnagil/bitnagil_backend/report/response/ReportInfo.java

@@ -0,0 +1,38 @@
+package bitnagil.bitnagil_backend.report.response;
+
+import bitnagil.bitnagil_backend.report.domain.enums.ReportCategory;
+import bitnagil.bitnagil_backend.report.domain.enums.ReportStatus;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+@Builder
+public class ReportInfo {
+
+    @Schema(description = "제보 ID 식별값입니다.",
+            example = "1")
+    private Long reportId;
+
+    @Schema(description = "현재 제보 상태",
+            example = "IN_PROGRESS")
+    private ReportStatus reportStatus;
+
+    @Schema(description = "제보 명",
+            example = "가로등 불 꺼짐")
+    private String reportTitle;
+
+    @Schema(description = "제보 카테고리",
+            example = "TRANSPORTATION")
+    private ReportCategory reportCategory;
+
+    @Schema(description = "제보 위치",
+            example = "서울시 강남구 삼성동")
+    private String reportLocation;
+
+    @Schema(description = "제보 이미지 URL 리스트",
+            example = "https://example.com/report/image1.jpg")
+    private String reportImageUrl;
+}

src/main/java/bitnagil/bitnagil_backend/report/response/ReportInfoResponse.java

@@ -0,0 +1,18 @@
+package bitnagil.bitnagil_backend.report.response;
+
+import java.time.LocalDate;
+import java.util.List;
+import java.util.Map;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public class ReportInfoResponse {
+
+    @Schema(description = "날짜 별 제보 목록\n\n제보한 기록이 없을 경우 빈 Map을 반환합니다.")
+    private Map<LocalDate, List<ReportInfo>> reportInfos;
+}

src/main/java/bitnagil/bitnagil_backend/report/service/ReportService.java

@@ -3,15 +3,22 @@
 import bitnagil.bitnagil_backend.global.errorcode.ErrorCode;
 import bitnagil.bitnagil_backend.global.exception.CustomException;
 import bitnagil.bitnagil_backend.report.domain.Report;
+import bitnagil.bitnagil_backend.report.domain.enums.ReportStatus;
 import bitnagil.bitnagil_backend.report.repository.ReportRepository;
 import bitnagil.bitnagil_backend.report.request.ReportRegisterRequest;
+import bitnagil.bitnagil_backend.report.response.ReportInfo;
+import bitnagil.bitnagil_backend.report.response.ReportInfoResponse;
 import bitnagil.bitnagil_backend.routineInfoV2.domain.RoutineInfoV2;
 import bitnagil.bitnagil_backend.user.domain.User;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.time.LocalDate;
+import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 @Service
 @RequiredArgsConstructor
@@ -23,20 +30,55 @@ public class ReportService {
     @Transactional
     public long registerReport(User user, ReportRegisterRequest request) {
         Report report = Report.builder()
-                .reportCategory(request.getReportCategory())
-                .reportImageUrls(request.getReportImageUrls())
-                .reportContent(request.getReportContent())
-                .reportLocation(request.getReportLocation())
-                .reportTitle(request.getReportTitle())
-                .latitude(request.getLatitude())
-                .longitude(request.getLongitude())
-                .user(user)
-                .build();
+            .reportStatus(ReportStatus.PENDING)
+            .reportCategory(request.getReportCategory())
+            .reportImageUrls(request.getReportImageUrls())
+            .reportContent(request.getReportContent())
+            .reportLocation(request.getReportLocation())
+            .reportTitle(request.getReportTitle())
+            .latitude(request.getLatitude())
+            .longitude(request.getLongitude())
+            .user(user)
+            .build();
 
         reportRepository.save(report);
         return report.getReportId();
     }
 
+    // 제보 전체 목록 조회
+    @Transactional(readOnly = true)
+    public ReportInfoResponse getAllReportInfo(User user) {
+        List<Report> reports = reportRepository.findByUser(user);
+
+        Map<LocalDate, List<ReportInfo>> reportInfoMap = new HashMap<>();
+
+        for (Report report : reports) {
+            LocalDate reportDate = report.getCreatedAt().toLocalDate();
+
+            ReportInfo reportInfo = ReportInfo.builder()
+                .reportId(report.getReportId())
+                .reportStatus(report.getReportStatus())
+                .reportTitle(report.getReportTitle())
+                .reportCategory(report.getReportCategory())
+                .reportLocation(report.getReportLocation())
+                .reportImageUrl(report.getReportImageUrls().get(0)) // 첫 번째 사진을 썸네일로 임의 설정
+                .build();
+
+            List<ReportInfo> reportInfos;
+            if (reportInfoMap.containsKey(reportDate)) {
+                reportInfos = reportInfoMap.get(reportDate);
+
+            } else {
+                reportInfos = new ArrayList<>();
+            }
+            reportInfos.add(reportInfo);
+            reportInfoMap.put(reportDate, reportInfos);
+
+        }
+
+        return new ReportInfoResponse(reportInfoMap);
+    }
+
     /* 추후에 변경을 고려해서 소스만 남겨놓음
     @Transactional
     public void updateImages(Long reportId, List<String> urls) {

src/main/resources/db/migration/V12__add_report_status_to_report.sql

@@ -0,0 +1,2 @@
+ALTER TABLE report
+    ADD COLUMN report_status VARCHAR(50) NOT NULL;