diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..fe1c3ab37 --- /dev/null +++ b/.gitignore @@ -0,0 +1,64 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!src/main/** +!src/test/** + +### macOS ### +.DS_Store + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +# Ignore Gradle build output directory +build + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +### Gradle Patch ### +# Java heap dump +*.hprof + +# log file +logs/ + +# docker +docker/database + +# Yaml +/src/main/resources/application-local.yml +/src/test/resources/application.yml diff --git a/README.md b/README.md index cb154de0f..e6b3b0d40 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,33 @@ # [미션] Spring Boot JPA로 게시판 구현 -## 미션 소개 😎 -Spring Boot JPA - Rest API를 강의를 듣고, 게시판 구현 미션을 수행해봅시다. +## 조셉팀 페어 프로그래밍 구성원 -## 이곳은 공개 Repo입니다. -1. 여러분의 포트폴리오로 사용하셔도 됩니다. -2. 때문에 이 repo를 fork한 뒤 -3. 여러분의 개인 Repo에 작업하며 -4. 이 Repo에 PR을 보내어 멘토의 코드 리뷰와 피드백을 받으세요. - -## Branch 명명 규칙 -1. 여러분 repo는 알아서 해주시고 😀(본인 레포니 main으로 하셔두 되져) -2. prgrms-be-devcourse/spring-board 레포로 PR시 branch는 본인 username을 적어주세요 :) -base repo : `여기repo` base : `username` ← head repo : `여러분repo` compare : `main` + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
홍혁준신재윤박세연
조셉팀조셉팀조셉팀
\ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 000000000..4245a6b5a --- /dev/null +++ b/build.gradle @@ -0,0 +1,97 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.2' + id 'io.spring.dependency-management' version '1.1.2' + id 'org.asciidoctor.jvm.convert' version '3.3.2' +} + +group = 'kr.co' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } + + asciidoctorExt +} + +repositories { + mavenCentral() +} + +ext { + snippetsDir = file('build/generated-snippets') +} + +//ext { +// asciidocVersion = "2.0.6.RELEASE" +// snippetsDir = file('build/generated-snippets') +//} + +dependencies { + // JPA + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + + // Validation + implementation 'org.springframework.boot:spring-boot-starter-validation' + + // Web + implementation 'org.springframework.boot:spring-boot-starter-web' + + // Lombok + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + + // Dev-Tool + developmentOnly 'org.springframework.boot:spring-boot-devtools' + + // H2 + runtimeOnly 'com.h2database:h2' + + // Test + testImplementation 'org.springframework.boot:spring-boot-starter-test' + + // Rest-Docs + asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor' + testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc' +} + +test { + outputs.dir snippetsDir +} + +tasks.named('test') { + outputs.dir snippetsDir + useJUnitPlatform() +} + +asciidoctor { + inputs.dir snippetsDir + configurations 'asciidoctorExt' + dependsOn test +} + +task copyDocument(type: Copy) { + dependsOn asciidoctor + doFirst { + delete file('src/main/resources/static/docs') + } + from file("build/docs/asciidoc") + into file("src/main/resources/static/docs") +} + +build { + dependsOn copyDocument +} + +bootJar { + dependsOn asciidoctor + from("${asciidoctor.outputDir}/html5") { + into 'static/docs' + } +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..033e24c4c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..9f4197d5f --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 000000000..fcb6fca14 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 000000000..93e3f59f1 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 000000000..587a7d643 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'boardmission' diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc new file mode 100644 index 000000000..5a819ac36 --- /dev/null +++ b/src/docs/asciidoc/index.adoc @@ -0,0 +1,46 @@ += 홍박신의 우당탕탕 게시판 API 문서 +:doctype: book +:icons: font +:source-highlighter: highlightjs +:toc: left +:toclevels: 3 + +== 게시판 생성하기 + +=== Request + +include::{snippets}/boards/createBoard/http-request.adoc[] + +=== Response + +include::{snippets}/boards/createBoard/http-response.adoc[] + +== 게시판 단건 조회하기 + +=== Request + +include::{snippets}/boards/getBoard/http-request.adoc[] + +=== Response + +include::{snippets}/boards/getBoard/http-response.adoc[] + +== 게시판 페이지 조회하기 + +=== Request + +include::{snippets}/boards/getBoards/http-request.adoc[] + +=== Response + +include::{snippets}/boards/getBoards/http-response.adoc[] + +== 게시판 수정하기 + +=== Request + +include::{snippets}/boards/updateBoard/http-request.adoc[] + +=== Response + +include::{snippets}/boards/updateBoard/http-response.adoc[] \ No newline at end of file diff --git "a/src/docs/\354\232\224\352\265\254\354\202\254\355\225\255.md" "b/src/docs/\354\232\224\352\265\254\354\202\254\355\225\255.md" new file mode 100644 index 000000000..73df292a7 --- /dev/null +++ "b/src/docs/\354\232\224\352\265\254\354\202\254\355\225\255.md" @@ -0,0 +1,62 @@ +# 요구사항 + +--- + +### 공통 + +- Spring Data JPA를 사용한다. +- Datasource는 H2를 사용한다. +- 엔티티는 회원과 게시글이 있다. +- 회원과 게시글은 1:N 관계이다. +- REST-DOCS를 이용해 문서화한다. + +### 회원 + +- Id - PK +- name - 이름 +- age - 나이 혹은 생년월일 +- hobby - 취미 +- created_at - 생성일 +- modified_at - 수정일 + +### 게시판 + +- Id - PK +- title - 제목 +- content - 내용 +- member - FK +- created_at - 생성일 +- modified_at - 수정일 +- created_by - 생성자 +- modified_by - 수정자 + +# API 명세 + +--- + +### 게시글 + +- 게시글 단건 조회 + - HTTP Method : GET + - URI : “/api/v1/posts/{id}" + - Request : board_id + - Response : title, content, created_at, modified_at, created_by, modified_by +- 게시글 페이징 조회 + - HTTP Method : GET + - URI : “/api/v1/posts" + - Request : - + - Response : List{title, created_at, created_by} +- 게시글 작성 + - HTTP Method : POST + - URI : “/api/v1/posts” + - Request : title, content + - [x] 제목이 null일 수 없다. + - [x] 제목이 빈값일 수 없다. + - Response : created_by +- 게시글 수정 + - HTTP Method : PUT + - URI : “/api/v1/posts/{id}” + - Request : title, content + - [x] 제목이 null일 수 없다. + - [x] 제목이 빈값일 수 없다. + - Response : created_by diff --git a/src/main/java/kr/co/boardmission/BoardMissionApplication.java b/src/main/java/kr/co/boardmission/BoardMissionApplication.java new file mode 100644 index 000000000..d12cdb952 --- /dev/null +++ b/src/main/java/kr/co/boardmission/BoardMissionApplication.java @@ -0,0 +1,13 @@ +package kr.co.boardmission; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class BoardMissionApplication { + + public static void main(String[] args) { + SpringApplication.run(BoardMissionApplication.class, args); + } + +} diff --git a/src/main/java/kr/co/boardmission/board/application/BoardMapper.java b/src/main/java/kr/co/boardmission/board/application/BoardMapper.java new file mode 100644 index 000000000..f457d8fe4 --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/application/BoardMapper.java @@ -0,0 +1,34 @@ +package kr.co.boardmission.board.application; + +import kr.co.boardmission.board.domain.Board; +import kr.co.boardmission.board.dto.request.BoardRequest; +import kr.co.boardmission.board.dto.response.BoardResponse; +import kr.co.boardmission.board.dto.response.BoardSummary; +import kr.co.boardmission.member.domain.Member; +import org.springframework.stereotype.Component; + +@Component +public class BoardMapper { + public Board toBoard(BoardRequest request, Member member) { + return Board.create(request.getTitle(), request.getContent(), member); + } + + public BoardResponse toDto(Board board) { + return BoardResponse.builder() + .title(board.getTitle()) + .content(board.getContent()) + .createdAt(board.getCreatedAt()) + .modifiedAt(board.getModifiedAt()) + .createdBy(board.getCreatedBy()) + .modifiedBy(board.getModifiedBy()) + .build(); + } + + public static BoardSummary toSummaryDto(Board board) { + return BoardSummary.builder() + .title(board.getTitle()) + .createdAt(board.getCreatedAt()) + .createdBy(board.getCreatedBy()) + .build(); + } +} diff --git a/src/main/java/kr/co/boardmission/board/application/BoardService.java b/src/main/java/kr/co/boardmission/board/application/BoardService.java new file mode 100644 index 000000000..1da052dd2 --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/application/BoardService.java @@ -0,0 +1,60 @@ +package kr.co.boardmission.board.application; + +import kr.co.boardmission.board.domain.Board; +import kr.co.boardmission.board.domain.BoardRepository; +import kr.co.boardmission.board.dto.request.BoardRequest; +import kr.co.boardmission.board.dto.response.BoardResponse; +import kr.co.boardmission.board.dto.response.BoardSummary; +import kr.co.boardmission.member.application.MemberService; +import kr.co.boardmission.member.domain.Member; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.util.List; + +@Service +@RequiredArgsConstructor +@Transactional(readOnly = true) +public class BoardService { + private final BoardRepository boardRepository; + private final BoardMapper boardMapper; + private final MemberService memberService; + + @Transactional + public String createBoard(BoardRequest request) { + Member member = memberService.getMember(request.getMemberId()); + Board board = boardMapper.toBoard(request, member); + Board savedBoard = boardRepository.save(board); + + return savedBoard.getCreatedBy(); + } + + public BoardResponse getBoard(Long boardId) { + Board board = boardRepository.findById(boardId) + .orElseThrow(() -> new RuntimeException("Not Found Board")); + + return boardMapper.toDto(board); + } + + public List findAll(Pageable pageable) { + return boardRepository.findAll(pageable) + .map(BoardMapper::toSummaryDto) + .getContent(); + } + + @Transactional + public String updateBoard( + Long boardId, + BoardRequest request + ) { + Member member = memberService.getMember(request.getMemberId()); + Board board = boardRepository.findById(boardId) + .orElseThrow(() -> new RuntimeException("Not Found Board")); + + board.updateBoard(request, member.getName()); + + return board.getCreatedBy(); + } +} diff --git a/src/main/java/kr/co/boardmission/board/domain/BaseBoard.java b/src/main/java/kr/co/boardmission/board/domain/BaseBoard.java new file mode 100644 index 000000000..b9a9f169d --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/domain/BaseBoard.java @@ -0,0 +1,27 @@ +package kr.co.boardmission.board.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.MappedSuperclass; +import kr.co.boardmission.global.common.BaseTime; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@MappedSuperclass +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public abstract class BaseBoard extends BaseTime { + @Column(name = "created_by", length = 20, nullable = false, updatable = false) + protected String createdBy; + + @Column(name = "modified_by", length = 20) + protected String modifiedBy; + + protected BaseBoard( + String createdBy, + String modifiedBy + ) { + this.createdBy = createdBy; + this.modifiedBy = modifiedBy; + } +} diff --git a/src/main/java/kr/co/boardmission/board/domain/Board.java b/src/main/java/kr/co/boardmission/board/domain/Board.java new file mode 100644 index 000000000..a95a198b4 --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/domain/Board.java @@ -0,0 +1,61 @@ +package kr.co.boardmission.board.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.JoinColumn; +import jakarta.persistence.ManyToOne; +import jakarta.persistence.Table; +import kr.co.boardmission.board.dto.request.BoardRequest; +import kr.co.boardmission.member.domain.Member; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@Entity +@Table(name = "tbl_boards") +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Board extends BaseBoard { + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE) + @Column(name = "board_id") + private Long boardId; + + @Column(name = "title", length = 30, nullable = false) + private String title; + + @Column(name = "content", length = 65335, nullable = false) + private String content; + + @ManyToOne + @JoinColumn(name = "member_id") + private Member member; + + private Board( + final String title, + final String content, + final Member member + ) { + super(member.getName(), null); + this.title = title; + this.content = content; + this.member = member; + } + + public static Board create( + final String title, + final String content, + final Member member + ) { + return new Board(title, content, member); + } + + public void updateBoard(BoardRequest request, String modifiedBy) { + this.title = request.getTitle(); + this.content = request.getContent(); + this.modifiedBy = modifiedBy; + } +} diff --git a/src/main/java/kr/co/boardmission/board/domain/BoardRepository.java b/src/main/java/kr/co/boardmission/board/domain/BoardRepository.java new file mode 100644 index 000000000..f72a124f3 --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/domain/BoardRepository.java @@ -0,0 +1,6 @@ +package kr.co.boardmission.board.domain; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface BoardRepository extends JpaRepository { +} diff --git a/src/main/java/kr/co/boardmission/board/dto/request/BoardRequest.java b/src/main/java/kr/co/boardmission/board/dto/request/BoardRequest.java new file mode 100644 index 000000000..c208e28f2 --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/dto/request/BoardRequest.java @@ -0,0 +1,29 @@ +package kr.co.boardmission.board.dto.request; + +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.NotNull; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@NoArgsConstructor(access = AccessLevel.PRIVATE) +public class BoardRequest { + @NotBlank + private String title; + + private String content; + + @NotNull + private Long memberId; + + public BoardRequest( + String title, + String content, + Long memberId + ) { + this.title = title; + this.content = content; + this.memberId = memberId; + } +} diff --git a/src/main/java/kr/co/boardmission/board/dto/response/BoardResponse.java b/src/main/java/kr/co/boardmission/board/dto/response/BoardResponse.java new file mode 100644 index 000000000..2b12ef57a --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/dto/response/BoardResponse.java @@ -0,0 +1,16 @@ +package kr.co.boardmission.board.dto.response; + +import lombok.Builder; + +import java.time.LocalDateTime; + +@Builder +public record BoardResponse( + String title, + String content, + LocalDateTime createdAt, + LocalDateTime modifiedAt, + String createdBy, + String modifiedBy +) { +} \ No newline at end of file diff --git a/src/main/java/kr/co/boardmission/board/dto/response/BoardSummary.java b/src/main/java/kr/co/boardmission/board/dto/response/BoardSummary.java new file mode 100644 index 000000000..0429338b8 --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/dto/response/BoardSummary.java @@ -0,0 +1,13 @@ +package kr.co.boardmission.board.dto.response; + +import lombok.Builder; + +import java.time.LocalDateTime; + +@Builder +public record BoardSummary( + String title, + LocalDateTime createdAt, + String createdBy +) { +} diff --git a/src/main/java/kr/co/boardmission/board/presentation/BoardController.java b/src/main/java/kr/co/boardmission/board/presentation/BoardController.java new file mode 100644 index 000000000..43c3d4580 --- /dev/null +++ b/src/main/java/kr/co/boardmission/board/presentation/BoardController.java @@ -0,0 +1,62 @@ +package kr.co.boardmission.board.presentation; + +import jakarta.validation.Valid; +import kr.co.boardmission.board.application.BoardService; +import kr.co.boardmission.board.dto.request.BoardRequest; +import kr.co.boardmission.board.dto.response.BoardResponse; +import kr.co.boardmission.board.dto.response.BoardSummary; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Pageable; +import org.springframework.data.domain.Sort; +import org.springframework.data.web.PageableDefault; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.PutMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import java.util.List; + +@RestController +@RequiredArgsConstructor +@RequestMapping("/api/v1/boards") +public class BoardController { + private final BoardService boardService; + + @PostMapping + public ResponseEntity createBoard(@RequestBody @Valid BoardRequest request) { + return ResponseEntity + .status(HttpStatus.CREATED) + .body(boardService.createBoard(request)); + } + + @GetMapping("/{board_id}") + public ResponseEntity getBoard(@PathVariable(name = "board_id") Long boardId) { + return ResponseEntity + .status(HttpStatus.OK) + .body(boardService.getBoard(boardId)); + } + + @GetMapping + public ResponseEntity> getBoardsPage( + @PageableDefault(size = 2, sort = "createdAt", direction = Sort.Direction.ASC) Pageable pageable + ) { + return ResponseEntity + .status(HttpStatus.OK) + .body(boardService.findAll(pageable)); + } + + @PutMapping("/{board_id}") + public ResponseEntity getBoardsPage( + @PathVariable(name = "board_id") Long boardId, + @RequestBody @Valid BoardRequest request + ) { + return ResponseEntity + .status(HttpStatus.OK) + .body(boardService.updateBoard(boardId, request)); + } +} diff --git a/src/main/java/kr/co/boardmission/global/common/BaseTime.java b/src/main/java/kr/co/boardmission/global/common/BaseTime.java new file mode 100644 index 000000000..a37312cc8 --- /dev/null +++ b/src/main/java/kr/co/boardmission/global/common/BaseTime.java @@ -0,0 +1,27 @@ +package kr.co.boardmission.global.common; + +import jakarta.persistence.Column; +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.annotation.LastModifiedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.LocalDateTime; + +@Getter +@MappedSuperclass +@EntityListeners(AuditingEntityListener.class) +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public abstract class BaseTime { + @CreatedDate + @Column(name = "created_at", length = 20, nullable = false, updatable = false) + protected LocalDateTime createdAt; + + @LastModifiedDate + @Column(name = "modified_at", length = 20) + protected LocalDateTime modifiedAt; +} diff --git a/src/main/java/kr/co/boardmission/global/config/JpaConfig.java b/src/main/java/kr/co/boardmission/global/config/JpaConfig.java new file mode 100644 index 000000000..e275eb893 --- /dev/null +++ b/src/main/java/kr/co/boardmission/global/config/JpaConfig.java @@ -0,0 +1,9 @@ +package kr.co.boardmission.global.config; + +import org.springframework.context.annotation.Configuration; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@Configuration +@EnableJpaAuditing +public class JpaConfig { +} diff --git a/src/main/java/kr/co/boardmission/member/application/MemberService.java b/src/main/java/kr/co/boardmission/member/application/MemberService.java new file mode 100644 index 000000000..aba644a8b --- /dev/null +++ b/src/main/java/kr/co/boardmission/member/application/MemberService.java @@ -0,0 +1,24 @@ +package kr.co.boardmission.member.application; + +import kr.co.boardmission.member.domain.Member; +import kr.co.boardmission.member.domain.MemberRepository; +import lombok.RequiredArgsConstructor; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Service +@RequiredArgsConstructor +@Transactional(readOnly = true) +public class MemberService { + private final MemberRepository memberRepository; + + @Transactional + public Member createMember(String name) { + return memberRepository.save(new Member(name)); + } + + public Member getMember(Long id) { + return memberRepository.findById(id) + .orElseThrow(() -> new RuntimeException("Not Found Member")); + } +} diff --git a/src/main/java/kr/co/boardmission/member/domain/Member.java b/src/main/java/kr/co/boardmission/member/domain/Member.java new file mode 100644 index 000000000..01870d695 --- /dev/null +++ b/src/main/java/kr/co/boardmission/member/domain/Member.java @@ -0,0 +1,30 @@ +package kr.co.boardmission.member.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.Table; +import kr.co.boardmission.global.common.BaseTime; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@Entity +@Table(name = "tbl_members") +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Member extends BaseTime { + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE) + @Column(name = "member_id") + private Long memberId; + + @Column(name = "name") + private String name; + + public Member(String name) { + this.name = name; + } +} diff --git a/src/main/java/kr/co/boardmission/member/domain/MemberRepository.java b/src/main/java/kr/co/boardmission/member/domain/MemberRepository.java new file mode 100644 index 000000000..9ab55077d --- /dev/null +++ b/src/main/java/kr/co/boardmission/member/domain/MemberRepository.java @@ -0,0 +1,8 @@ +package kr.co.boardmission.member.domain; + +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface MemberRepository extends JpaRepository { +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 000000000..d74c444c1 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,3 @@ +spring: + profiles: + active: local diff --git a/src/main/resources/static/docs/index.html b/src/main/resources/static/docs/index.html new file mode 100644 index 000000000..3a2e4174f --- /dev/null +++ b/src/main/resources/static/docs/index.html @@ -0,0 +1,628 @@ + + + + + + + +홍박신의 우당탕탕 게시판 API 문서 + + + + + + + +
+
+

게시판 생성하기

+
+
+

Request

+
+
+
POST /api/v1/boards HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 66
+Host: localhost:8080
+
+{
+  "title" : "title",
+  "content" : "content",
+  "memberId" : 2
+}
+
+
+
+
+

Response

+
+
+
HTTP/1.1 201 Created
+Content-Type: text/plain;charset=UTF-8
+Content-Length: 14
+
+testMemberName
+
+
+
+
+
+
+

게시판 단건 조회하기

+
+
+

Request

+
+
+
GET /api/v1/boards/9 HTTP/1.1
+Host: localhost:8080
+
+
+
+
+

Response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 198
+
+{
+  "title" : "title",
+  "content" : "content",
+  "createdAt" : "2023-08-01T17:55:14.624693",
+  "modifiedAt" : "2023-08-01T17:55:14.624693",
+  "createdBy" : "testMemberName",
+  "modifiedBy" : null
+}
+
+
+
+
+
+
+

게시판 페이지 조회하기

+
+
+

Request

+
+
+
GET /api/v1/boards?page=1&size=2 HTTP/1.1
+Host: localhost:8080
+
+
+
+
+

Response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 206
+
+[ {
+  "title" : "t2",
+  "createdAt" : "2023-08-01T17:55:14.500436",
+  "createdBy" : "testMemberName"
+}, {
+  "title" : "t3",
+  "createdAt" : "2023-08-01T17:55:14.500543",
+  "createdBy" : "testMemberName"
+} ]
+
+
+
+
+
+
+

게시판 수정하기

+
+
+

Request

+
+
+
PUT /api/v1/boards/1 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 66
+Host: localhost:8080
+
+{
+  "title" : "title",
+  "content" : "content",
+  "memberId" : 1
+}
+
+
+
+
+

Response

+
+
+
HTTP/1.1 200 OK
+Content-Type: text/plain;charset=UTF-8
+Content-Length: 14
+
+testMemberName
+
+
+
+
+
+
+ + + + + \ No newline at end of file diff --git a/src/test/java/kr/co/boardmission/board/application/BoardServiceTest.java b/src/test/java/kr/co/boardmission/board/application/BoardServiceTest.java new file mode 100644 index 000000000..e2cf4c14b --- /dev/null +++ b/src/test/java/kr/co/boardmission/board/application/BoardServiceTest.java @@ -0,0 +1,122 @@ +package kr.co.boardmission.board.application; + +import kr.co.boardmission.board.domain.Board; +import kr.co.boardmission.board.domain.BoardFactory; +import kr.co.boardmission.board.domain.BoardRepository; +import kr.co.boardmission.board.dto.request.BoardRequest; +import kr.co.boardmission.board.dto.response.BoardResponse; +import kr.co.boardmission.board.dto.response.BoardSummary; +import kr.co.boardmission.member.application.MemberService; +import kr.co.boardmission.member.domain.Member; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.Spy; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.PageImpl; +import org.springframework.data.domain.PageRequest; +import org.springframework.data.domain.Pageable; + +import java.util.List; +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.BDDMockito.given; + + +@ExtendWith(MockitoExtension.class) +class BoardServiceTest { + @InjectMocks + private BoardService boardService; + + @Mock + private BoardRepository boardRepository; + + @Mock + private MemberService memberService; + + @Spy + private BoardMapper boardMapper; + + private Member member; + + @BeforeEach + void setUp() { + member = new Member("memberName"); + } + + @DisplayName("게시글 생성 - 성공") + @Test + void create_board_success() { + // Given + BoardRequest createRequest = BoardFactory.createBoardCreateRequest(1L); + Board board = boardMapper.toBoard(createRequest, member); + + given(memberService.getMember(any(Long.class))).willReturn(member); + given(boardRepository.save(any(Board.class))).willReturn(board); + + // When + String actual = boardService.createBoard(createRequest); + + // Then + assertThat(actual).isEqualTo(board.getCreatedBy()); + } + + @DisplayName("게시글 단건 조회 - 성공") + @Test + void get_boards_detail_success() { + // Given + Board board = BoardFactory.createBoard("title", "content", member); + given(boardRepository.findById(1L)).willReturn(Optional.of(board)); + + // When + BoardResponse actual = boardService.getBoard(1L); + + // Then + assertThat(actual.title()).isEqualTo(board.getTitle()); + assertThat(actual.content()).isEqualTo(board.getContent()); + assertThat(actual.createdAt()).isEqualTo(board.getCreatedAt()); + assertThat(actual.modifiedAt()).isEqualTo(board.getModifiedAt()); + assertThat(actual.createdBy()).isEqualTo(board.getCreatedBy()); + assertThat(actual.modifiedBy()).isEqualTo(board.getModifiedBy()); + } + + @DisplayName("게시글 페이지 단위 조회 - 성공") + @Test + void get_boards_paging_success() { + // Given + Board board1 = BoardFactory.createBoard("t1", "c1", member); + Board board2 = BoardFactory.createBoard("t2", "c2", member); + Page boards = new PageImpl<>(List.of(board1, board2)); + + given(boardRepository.findAll(any(Pageable.class))).willReturn(boards); + + // When + List actual = boardService.findAll(PageRequest.of(0, 2)); + + // Then + assertThat(actual).hasSize(2); + } + + @DisplayName("게시판 페이지 단위 수정 - 성공") + @Test + void update_board_success() { + // Given + Board board = BoardFactory.createBoard("t1", "c1", member); + BoardRequest request = BoardFactory.createBoardCreateRequest(1L); + + given(memberService.getMember(any(Long.class))).willReturn(member); + given(boardRepository.findById(any(Long.class))).willReturn(Optional.of(board)); + + // When + String actual = boardService.updateBoard(1L, request); + + // Then + assertThat(actual).isEqualTo(member.getName()); + } +} diff --git a/src/test/java/kr/co/boardmission/board/domain/BoardFactory.java b/src/test/java/kr/co/boardmission/board/domain/BoardFactory.java new file mode 100644 index 000000000..7968521be --- /dev/null +++ b/src/test/java/kr/co/boardmission/board/domain/BoardFactory.java @@ -0,0 +1,14 @@ +package kr.co.boardmission.board.domain; + +import kr.co.boardmission.board.dto.request.BoardRequest; +import kr.co.boardmission.member.domain.Member; + +public class BoardFactory { + public static Board createBoard(String title, String content, Member member) { + return Board.create(title, content, member); + } + + public static BoardRequest createBoardCreateRequest(Long memberId) { + return new BoardRequest("title", "content", memberId); + } +} diff --git a/src/test/java/kr/co/boardmission/board/domain/BoardTest.java b/src/test/java/kr/co/boardmission/board/domain/BoardTest.java new file mode 100644 index 000000000..1445a162b --- /dev/null +++ b/src/test/java/kr/co/boardmission/board/domain/BoardTest.java @@ -0,0 +1,32 @@ +package kr.co.boardmission.board.domain; + +import kr.co.boardmission.member.domain.Member; +import kr.co.boardmission.member.domain.MemberRepository; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; +import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +@DataJpaTest +class BoardTest { + @Autowired + MemberRepository memberRepository; + + @Autowired + TestEntityManager entityManager; + + @DisplayName("게시글 제목이 비었을 때 예외 던지는지 확인 - ConstraintViolationException") + @Test + void board_title_null_ConstraintViolationException() { + // Given + Member member = memberRepository.save(new Member("member")); + Board board = BoardFactory.createBoard(null, "content", member); + + // When // Then + assertThatThrownBy(() -> entityManager.persistAndFlush(board)) + .isInstanceOf(org.hibernate.exception.ConstraintViolationException.class); + } +} diff --git a/src/test/java/kr/co/boardmission/board/presentation/BoardControllerTest.java b/src/test/java/kr/co/boardmission/board/presentation/BoardControllerTest.java new file mode 100644 index 000000000..5be29df62 --- /dev/null +++ b/src/test/java/kr/co/boardmission/board/presentation/BoardControllerTest.java @@ -0,0 +1,134 @@ +package kr.co.boardmission.board.presentation; + +import com.fasterxml.jackson.databind.ObjectMapper; +import kr.co.boardmission.BoardMissionApplication; +import kr.co.boardmission.board.domain.Board; +import kr.co.boardmission.board.domain.BoardFactory; +import kr.co.boardmission.board.domain.BoardRepository; +import kr.co.boardmission.board.dto.request.BoardRequest; +import kr.co.boardmission.member.application.MemberService; +import kr.co.boardmission.member.domain.Member; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.transaction.annotation.Transactional; + +import java.util.ArrayList; +import java.util.List; + +import static org.hamcrest.Matchers.hasSize; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest; +import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse; +import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@Transactional +@SpringBootTest(classes = BoardMissionApplication.class) +@AutoConfigureRestDocs +@AutoConfigureMockMvc +class BoardControllerTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + private ObjectMapper objectMapper; + + @Autowired + private MemberService memberService; + + @Autowired + private BoardRepository boardRepository; + + private BoardRequest request; + private Member member; + private Board board; + + @BeforeEach + void beforeEach() { + member = memberService.createMember("testMemberName"); + request = BoardFactory.createBoardCreateRequest(member.getMemberId()); + board = boardRepository.save(BoardFactory.createBoard("title", "content", member)); + } + + @DisplayName("/api/v1/boards - 게시판 등록 API 테스트 with 성공") + @Test + void create_board_api_success() throws Exception { + // When // Then + mockMvc.perform(post("/api/v1/boards") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andDo(print()) + .andDo(document("boards/createBoard", + preprocessRequest(prettyPrint()), + preprocessResponse(prettyPrint()))) + .andExpect(status().is(HttpStatus.CREATED.value())); + } + + @DisplayName("/api/v1/boards/{board_id} - 게시판 단건 조회 API 테스트 with 성공") + @Test + void get_board_api_success() throws Exception { + // When // Then + mockMvc.perform(get("/api/v1/boards/" + board.getBoardId())) + .andDo(print()) + .andDo(document("boards/getBoard", + preprocessRequest(prettyPrint()), + preprocessResponse(prettyPrint()))) + .andExpect(status().is(HttpStatus.OK.value())) + .andExpect(jsonPath("$.title").exists()) + .andExpect(jsonPath("$.content").exists()) + .andExpect(jsonPath("$.createdAt").exists()) + .andExpect(jsonPath("$.createdBy").exists()); + } + + @DisplayName("/api/v1/boards - 게시판 페이징 조회 API 테스트 with 성공") + @Test + void get_boards_paging_success() throws Exception { + // Given + Board board1 = BoardFactory.createBoard("t1", "c1", member); + Board board2 = BoardFactory.createBoard("t2", "c2", member); + Board board3 = BoardFactory.createBoard("t3", "c3", member); + Board board4 = BoardFactory.createBoard("t4", "c4", member); + List boards = new ArrayList<>(List.of(board, board1, board2, board3, board4)); + + boardRepository.saveAll(boards); + + // When // Then + mockMvc.perform(get("/api/v1/boards") + .param("page", "1") + .param("size", "2")) + .andDo(print()) + .andDo(document("boards/getBoards", + preprocessRequest(prettyPrint()), + preprocessResponse(prettyPrint()))) + .andExpect(status().is(HttpStatus.OK.value())) + .andExpect(jsonPath("$.*", hasSize(2))); + } + + @DisplayName("/api/v1/boards/{board_id} - 게시글 수정 API 테스트 with 성공") + @Test + void update_member_success() throws Exception { + mockMvc.perform(put("/api/v1/boards/" + board.getBoardId()) + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(request))) + .andDo(print()) + .andDo(document("boards/updateBoard", + preprocessRequest(prettyPrint()), + preprocessResponse(prettyPrint()))) + .andExpect(content().string(member.getName())); + } +}