Merge pull request #34 from Team-UMC/feature/#23/board-api

[FEAT] 게시판 API 구현

build.gradle

@@ -2,11 +2,14 @@ plugins {
 	id 'java'
 	id 'org.springframework.boot' version '3.2.1'
 	id 'io.spring.dependency-management' version '1.1.4'
+	// queryDsl Settings
+	id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
 }
 
 group = 'com.umc'
 version = '0.0.1-SNAPSHOT'
 
+
 java {
 	sourceCompatibility = '17'
 }
@@ -21,6 +24,7 @@ repositories {
 	mavenCentral()
 }
 
+
 dependencies {
 	implementation 'io.jsonwebtoken:jjwt:0.9.1'
 
@@ -47,6 +51,12 @@ dependencies {
 	// s3 setting
 	implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
 
+	//query dsl
+	implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+	annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
+	annotationProcessor "jakarta.annotation:jakarta.annotation-api"
+	annotationProcessor "jakarta.persistence:jakarta.persistence-api"
+
 	// 스프링 시큐리티를 사용하기 위한 스타터 추가
 	implementation 'org.springframework.boot:spring-boot-starter-security'
 
@@ -63,3 +73,26 @@ dependencies {
 tasks.named('test') {
 	useJUnitPlatform()
 }
+
+//querydsl 빌드 옵션
+def querydslDir = "$buildDir/generated/querydsl"
+
+querydsl {
+	jpa = true
+	querydslSourcesDir = querydslDir
+}
+
+sourceSets {
+	main.java.srcDir querydslDir
+}
+
+configurations {
+	compileOnly {
+		extendsFrom annotationProcessor
+	}
+	querydsl.extendsFrom compileClasspath
+}
+
+compileQuerydsl {
+	options.annotationProcessorPath = configurations.querydsl
+}

src/main/java/com/umc/networkingService/config/QueryDSLConfig.java

@@ -0,0 +1,19 @@
+package com.umc.networkingService.config;
+
+import com.querydsl.jpa.impl.JPAQueryFactory;
+import jakarta.persistence.EntityManager;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+
+@Configuration
+@RequiredArgsConstructor
+public class QueryDSLConfig {
+    private final EntityManager entityManager;
+
+    @Bean
+    public JPAQueryFactory jpaQueryFactory() {
+        return new JPAQueryFactory(entityManager);
+    }
+}

src/main/java/com/umc/networkingService/domain/board/controller/BoardCommentController.java

@@ -0,0 +1,125 @@
+package com.umc.networkingService.domain.board.controller;
+
+import com.umc.networkingService.config.security.auth.CurrentMember;
+import com.umc.networkingService.domain.board.dto.request.comment.BoardCommentAddRequest;
+import com.umc.networkingService.domain.board.dto.request.comment.BoardCommentUpdateRequest;
+import com.umc.networkingService.domain.board.dto.response.comment.BoardCommentIdResponse;
+import com.umc.networkingService.domain.board.dto.response.comment.BoardCommentPagingResponse;
+import com.umc.networkingService.domain.board.dto.response.member.MyBoardCommentPagingWebResponse;
+import com.umc.networkingService.domain.board.dto.response.member.MyBoardPagingResponse;
+import com.umc.networkingService.domain.board.entity.BoardType;
+import com.umc.networkingService.domain.board.entity.HostType;
+import com.umc.networkingService.domain.board.service.BoardCommentService;
+import com.umc.networkingService.domain.member.entity.Member;
+import com.umc.networkingService.global.common.base.BaseResponse;
+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.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
+import org.springframework.data.web.PageableDefault;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.UUID;
+
+@Tag(name = "게시판 댓글 API", description = "게시판 댓글 관련 API")
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/boards/comments")
+public class BoardCommentController {
+
+    private final BoardCommentService boardCommentService;
+
+    @Operation(summary = "댓글 작성 API", description = "댓글을 작성하는 API입니다.")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "COMMON200", description = "성공"),
+    })
+    @PostMapping
+    public BaseResponse<BoardCommentIdResponse> addBoardComment(@CurrentMember Member member,
+                                                                @Valid @RequestBody BoardCommentAddRequest request) {
+        return BaseResponse.onSuccess(boardCommentService.addBoardComment(member, request));
+    }
+
+    @Operation(summary = "댓글 수정 API", description = "댓글을 수정하는 API입니다.")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "COMMON200", description = "성공"),
+            @ApiResponse(responseCode = "COMMENT001", description = "댓글을 찾을 수 없을 경우 발생"),
+            @ApiResponse(responseCode = "COMMENT002", description = "댓글 수정 권한이 없을 경우 발생"),
+
+    })
+    @PatchMapping("/{commentId}")
+    public BaseResponse<BoardCommentIdResponse> updateBoardComment(@CurrentMember Member member,
+                                                                   @PathVariable(value = "commentId") UUID commentId,
+                                                                   @Valid @RequestBody BoardCommentUpdateRequest request) {
+        return BaseResponse.onSuccess(boardCommentService.updateBoardComment(member, commentId, request));
+    }
+
+
+    @Operation(summary = "댓글 삭제 API", description = "댓글을 삭제하는 API입니다.")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "COMMON200", description = "성공"),
+            @ApiResponse(responseCode = "COMMENT001", description = "댓글을 찾을 수 없을 경우 발생"),
+            @ApiResponse(responseCode = "COMMENT002", description = "댓글 삭제 권한이 없을 경우 발생")
+    })
+    @DeleteMapping("/{commentId}")
+    public BaseResponse<BoardCommentIdResponse> deleteBoardComment(@CurrentMember Member member,
+                                                                   @PathVariable(value = "commentId") UUID commentId) {
+        return BaseResponse.onSuccess(boardCommentService.deleteBoardComment(member, commentId));
+    }
+
+    @Operation(summary = " 특정 게시글 댓글 목록 조회 API", description = "특정 게시글의 댓글 목록을 조회하는 API입니다.")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "COMMON200", description = "성공"),
+            @ApiResponse(responseCode = "BOARD002", description = "게시글을 찾을 수 없을 경우 발생")
+    })
+    @Parameters(value = {
+            @Parameter(name = "page", description = " page 시작은 0번부터, 오름차순으로 조회됩니다.")
+    })
+    @GetMapping(value = "/{boardId}")
+    public BaseResponse<BoardCommentPagingResponse> showBoardComments(@CurrentMember Member member,
+                                                                      @PathVariable(value = "boardId") UUID boardId,
+                                                                      @PageableDefault(sort = "created_at", direction = Sort.Direction.ASC)
+                                                                      @Parameter(hidden = true) Pageable pageable) {
+        return BaseResponse.onSuccess(boardCommentService.showBoardComments(member, boardId, pageable));
+    }
+
+    @Operation(summary = "[APP] 내가 댓글 쓴 글 조회/검색 API", description = "APP용 내가 댓글 쓴 글을 조회/검색하는 API입니다.")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "COMMON200", description = "성공"),
+    })
+    @Parameters(value = {
+            @Parameter(name = "keyword", description = "keyword를 주지 않으면 모든 내가 댓글 쓴 글이 조회됩니다. keyword를 주면 검색이 가능합니다."),
+            @Parameter(name = "page", description = "page 시작은 0번부터, 내림차순으로 조회됩니다.")
+    })
+    @GetMapping(value = "/member/comments/app")
+    public BaseResponse<MyBoardPagingResponse> showBoardsByMemberCommentsForApp(@CurrentMember Member member,
+                                                                                @RequestParam(name = "keyword", required = false) String keyword,
+                                                                                @PageableDefault(sort = "created_at", direction = Sort.Direction.DESC)
+                                                                                @Parameter(hidden = true) Pageable pageable) {
+        return BaseResponse.onSuccess(boardCommentService.showBoardsByMemberCommentForApp(member, keyword, pageable));
+    }
+
+    @Operation(summary = "[WEB] 내가 댓글 쓴 글 조회/검색 API", description = "WEB용 내가 댓글 쓴 글을 조회/검색하는 API입니다.  "+
+            "host: CENTER, BRANCH, CAMPUS 중 하나의 값을 대문자로 주세요.  " +
+            "board: NOTICE, FREE, WORKBOOK, OB, QUESTION 중 하나의 값을 대문자로 주세요.")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "COMMON200", description = "성공"),
+    })
+    @Parameters(value = {
+            @Parameter(name = "keyword", description = "keyword를 주지 않으면 모든 내가 댓글 쓴 글이 조회됩니다. keyword를 주면 검색이 가능합니다."),
+            @Parameter(name = "page", description = "page 시작은 0번부터, 내림차순으로 조회됩니다.")})
+    @GetMapping(value = "/member/comments/web")
+    public BaseResponse<MyBoardCommentPagingWebResponse> showBoardsByMemberCommentForWeb(@CurrentMember Member member,
+                                                                                          @RequestParam(name = "host") HostType hostType,
+                                                                                          @RequestParam(name = "board") BoardType boardType,
+                                                                                          @RequestParam(name = "keyword", required = false) String keyword,
+                                                                                          @PageableDefault(sort = "created_at", direction = Sort.Direction.DESC)
+                                                                                          @Parameter(hidden = true) Pageable pageable) {
+        return BaseResponse.onSuccess(boardCommentService.showBoardsByMemberCommentForWeb(member, hostType, boardType,keyword, pageable));
+    }
+}