diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..8aca08b4d --- /dev/null +++ b/.gitignore @@ -0,0 +1,44 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + + +### application.yml ### +application.yaml + +### DS_Store +.DS_Store diff --git a/build.gradle b/build.gradle new file mode 100644 index 000000000..9e429e097 --- /dev/null +++ b/build.gradle @@ -0,0 +1,84 @@ +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 = 'com.board' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + asciidoctorExtensions + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +ext { + set('snippetsDir', file("build/generated-snippets")) +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.h2database:h2' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc' + annotationProcessor 'org.projectlombok:lombok' + testAnnotationProcessor 'org.projectlombok:lombok' + + // JPA & Database + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'mysql:mysql-connector-java:8.0.32' +} + +tasks.named('test') { + outputs.dir snippetsDir + useJUnitPlatform() +} + +tasks.named('asciidoctor') { + inputs.dir snippetsDir + dependsOn test +} + +task copyDocument(type: Copy) { + dependsOn asciidoctor + from file("build/docs/asciidoc") + into file("src/main/resources/static/docs") +} + +asciidoctor.doFirst { + delete file('src/main/resources/static/docs') +} + +build { + dependsOn copyDocument +} + +bootJar { + dependsOn copyDocument + from "${asciidoctor.outputDir}" + into 'static/docs' + +} + +asciidoctor { + dependsOn test + configurations 'asciidoctorExtensions' + inputs.dir snippetsDir + + sources { + include("**/index.adoc", "**/common/*.adoc") + } + baseDirFollowsSourceFile() +} \ 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..6689b85be --- /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..096502d21 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'server' diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc new file mode 100644 index 000000000..6e3ce1a20 --- /dev/null +++ b/src/docs/asciidoc/index.adoc @@ -0,0 +1,61 @@ +ifndef::snippets[] +:snippets: ../../../build/generated-snippets +endif::[] + += REST Docs 게시판 API +:doctype: book +:icons: font +:source-highlighter: highlightjs +:toc: left +:toclevels: 2 +:sectlinks: + +[[Post-API]] + +== Post API + +=== 게시글 등록 + +=== [POST] ~/post + +.Request +include::{snippets}/post-save/http-request.adoc[] +include::{snippets}/post-save/request-fields.adoc[] + +.Response +include::{snippets}/post-save/http-response.adoc[] +include::{snippets}/post-save/response-fields.adoc[] + +=== 게시글 전체 조회 + +=== [GET] ~/post + +.Request +include::{snippets}/get-all-post/http-request.adoc[] + +.Response +include::{snippets}/get-all-post/http-response.adoc[] +include::{snippets}/get-all-post/response-fields.adoc[] + +=== 게시글 단일 조회 + +=== [GET] ~/post/{postId} + +.Request +include::{snippets}/get-one-post/http-request.adoc[] + +.Response +include::{snippets}/get-one-post/http-response.adoc[] +include::{snippets}/get-one-post/response-fields.adoc[] + +=== 게시글 수정 + +=== [PATCH] ~/post/{postId} + +.Request +include::{snippets}/update-post/http-request.adoc[] + +.Response +include::{snippets}/update-post/http-response.adoc[] +include::{snippets}/update-post/response-fields.adoc[] + diff --git a/src/main/java/com/board/server/ServerApplication.java b/src/main/java/com/board/server/ServerApplication.java new file mode 100644 index 000000000..28bc54309 --- /dev/null +++ b/src/main/java/com/board/server/ServerApplication.java @@ -0,0 +1,15 @@ +package com.board.server; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@EnableJpaAuditing +@SpringBootApplication +public class ServerApplication { + + public static void main(String[] args) { + SpringApplication.run(ServerApplication.class, args); + } + +} diff --git a/src/main/java/com/board/server/domain/post/controller/PostController.java b/src/main/java/com/board/server/domain/post/controller/PostController.java new file mode 100644 index 000000000..e64f6baf8 --- /dev/null +++ b/src/main/java/com/board/server/domain/post/controller/PostController.java @@ -0,0 +1,61 @@ +package com.board.server.domain.post.controller; + +import com.board.server.domain.post.dto.request.CreatePostRequest; +import com.board.server.domain.post.dto.request.UpdatePostRequest; +import com.board.server.domain.post.dto.response.PostResponse; +import com.board.server.domain.post.dto.response.PostsResponse; +import com.board.server.domain.post.service.PostService; +import com.board.server.global.common.dto.ApiResponse; +import com.board.server.global.exception.Error; +import com.board.server.global.exception.Success; +import lombok.RequiredArgsConstructor; +import org.springframework.http.HttpStatus; +import org.springframework.web.bind.annotation.*; + +@RestController +@RequiredArgsConstructor +@RequestMapping("/posts") +public class PostController { + + private final PostService postService; + + @GetMapping + @ResponseStatus(HttpStatus.OK) + public ApiResponse getAllPost( + @RequestParam int page + ) { + if (page < 1) { + return ApiResponse.error(Error.PAGE_REQUEST_VALIDATION_EXCEPTION, Error.PAGE_REQUEST_VALIDATION_EXCEPTION.getMessage()); + } + + return ApiResponse.success(Success.GET_POST_LIST_SUCCESS, postService.getAllPost(page)); + } + + @GetMapping("/{postId}") + @ResponseStatus(HttpStatus.OK) + public ApiResponse getPost( + @PathVariable Long postId + ) { + return ApiResponse.success(Success.GET_POST_SUCCESS, postService.getPost(postId)); + } + + @PostMapping + @ResponseStatus(HttpStatus.CREATED) + public ApiResponse createPost( + @RequestHeader Long userId, + @RequestBody CreatePostRequest request + ) { + return ApiResponse.success(Success.CREATE_POST_SUCCESS, postService.createPost(request, userId)); + } + + @PatchMapping("/{postId}") + @ResponseStatus(HttpStatus.OK) + public ApiResponse updatePost( + @PathVariable Long postId, + @RequestBody UpdatePostRequest request, + @RequestHeader Long userId + ) { + return ApiResponse.success(Success.UPDATE_POST_SUCCESS, postService.updatePost(request, postId, userId)); + } + +} diff --git a/src/main/java/com/board/server/domain/post/dto/request/CreatePostRequest.java b/src/main/java/com/board/server/domain/post/dto/request/CreatePostRequest.java new file mode 100644 index 000000000..9436e8020 --- /dev/null +++ b/src/main/java/com/board/server/domain/post/dto/request/CreatePostRequest.java @@ -0,0 +1,7 @@ +package com.board.server.domain.post.dto.request; + +public record CreatePostRequest( + String title, + String content +) { +} diff --git a/src/main/java/com/board/server/domain/post/dto/request/UpdatePostRequest.java b/src/main/java/com/board/server/domain/post/dto/request/UpdatePostRequest.java new file mode 100644 index 000000000..4ab490c5b --- /dev/null +++ b/src/main/java/com/board/server/domain/post/dto/request/UpdatePostRequest.java @@ -0,0 +1,7 @@ +package com.board.server.domain.post.dto.request; + +public record UpdatePostRequest( + String title, + String content +) { +} diff --git a/src/main/java/com/board/server/domain/post/dto/response/PageInfo.java b/src/main/java/com/board/server/domain/post/dto/response/PageInfo.java new file mode 100644 index 000000000..13ff3c33b --- /dev/null +++ b/src/main/java/com/board/server/domain/post/dto/response/PageInfo.java @@ -0,0 +1,18 @@ +package com.board.server.domain.post.dto.response; + +import lombok.Builder; + +@Builder +public record PageInfo( + int totalPageSize, + int currentPageIndex, + Boolean isEnd +) { + public static PageInfo of(int totalPageSize, int currentPageIndex, Boolean isEnd) { + return PageInfo.builder() + .totalPageSize(totalPageSize) + .currentPageIndex(currentPageIndex) + .isEnd(isEnd) + .build(); + } +} diff --git a/src/main/java/com/board/server/domain/post/dto/response/PostResponse.java b/src/main/java/com/board/server/domain/post/dto/response/PostResponse.java new file mode 100644 index 000000000..148452793 --- /dev/null +++ b/src/main/java/com/board/server/domain/post/dto/response/PostResponse.java @@ -0,0 +1,24 @@ +package com.board.server.domain.post.dto.response; + +import lombok.Builder; + +import java.time.LocalDateTime; + +@Builder +public record PostResponse( + Long postId, + String title, + String content, + String createdBy, + LocalDateTime createdAt +) { + public static PostResponse of(Long postId, String title, String content, String createdBy, LocalDateTime createdAt) { + return PostResponse.builder() + .postId(postId) + .title(title) + .content(content) + .createdBy(createdBy) + .createdAt(createdAt) + .build(); + } +} diff --git a/src/main/java/com/board/server/domain/post/dto/response/PostsResponse.java b/src/main/java/com/board/server/domain/post/dto/response/PostsResponse.java new file mode 100644 index 000000000..b6a61d803 --- /dev/null +++ b/src/main/java/com/board/server/domain/post/dto/response/PostsResponse.java @@ -0,0 +1,18 @@ +package com.board.server.domain.post.dto.response; + +import lombok.Builder; + +import java.util.List; + +@Builder +public record PostsResponse( + List postResponses, + PageInfo pageInfo +) { + public static PostsResponse of(List postResponses, PageInfo pageInfo) { + return PostsResponse.builder() + .postResponses(postResponses) + .pageInfo(pageInfo) + .build(); + } +} diff --git a/src/main/java/com/board/server/domain/post/entity/Post.java b/src/main/java/com/board/server/domain/post/entity/Post.java new file mode 100644 index 000000000..e7379cd31 --- /dev/null +++ b/src/main/java/com/board/server/domain/post/entity/Post.java @@ -0,0 +1,43 @@ +package com.board.server.domain.post.entity; + +import com.board.server.domain.user.entity.User; +import com.board.server.global.common.dto.BaseEntity; +import jakarta.persistence.*; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Entity +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Post extends BaseEntity { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long postId; + + @Column(nullable = false) + private String title; + + @Column(nullable = false) + private String content; + + @ManyToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL) + @JoinColumn(name = "user_id") + private User user; + + @Builder + public Post(String title, String content, User user) { + this.title = title; + this.content = content; + this.user = user; + } + + public void updateTitle(String title) { + this.title = title; + } + + public void updateContent(String content) { + this.content = content; + } +} diff --git a/src/main/java/com/board/server/domain/post/entity/PostRepository.java b/src/main/java/com/board/server/domain/post/entity/PostRepository.java new file mode 100644 index 000000000..1a9c1b10e --- /dev/null +++ b/src/main/java/com/board/server/domain/post/entity/PostRepository.java @@ -0,0 +1,23 @@ +package com.board.server.domain.post.entity; + +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Query; + +import java.util.Optional; + +public interface PostRepository extends JpaRepository { + // CREATE + + // READ + Page findAllByOrderByCreatedAtDesc(Pageable pageable); + + @Query("select p from Post p join fetch p.user where p.postId = :postId") + Optional findById(Long postId); + + // UPDATE + + // DELETE + +} diff --git a/src/main/java/com/board/server/domain/post/service/PostService.java b/src/main/java/com/board/server/domain/post/service/PostService.java new file mode 100644 index 000000000..c4bb3b61f --- /dev/null +++ b/src/main/java/com/board/server/domain/post/service/PostService.java @@ -0,0 +1,113 @@ +package com.board.server.domain.post.service; + +import com.board.server.domain.post.dto.request.CreatePostRequest; +import com.board.server.domain.post.dto.request.UpdatePostRequest; +import com.board.server.domain.post.dto.response.PageInfo; +import com.board.server.domain.post.dto.response.PostResponse; +import com.board.server.domain.post.dto.response.PostsResponse; +import com.board.server.domain.post.entity.Post; +import com.board.server.domain.post.entity.PostRepository; +import com.board.server.domain.user.entity.User; +import com.board.server.domain.user.entity.UserRepository; +import com.board.server.global.exception.Error; +import com.board.server.global.exception.model.NotFoundException; +import com.board.server.global.exception.model.UnauthorizedException; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.PageRequest; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.util.List; + +@Service +@RequiredArgsConstructor +public class PostService { + + private final PostRepository postRepository; + private final UserRepository userRepository; + + private static final int PAGE_SIZE = 10; + + @Transactional + public PostResponse createPost(CreatePostRequest request, Long userId) { + User user = userRepository.findById(userId) + .orElseThrow(() -> new NotFoundException(Error.NOT_FOUND_USER_EXCEPTION, Error.NOT_FOUND_USER_EXCEPTION.getMessage())); + + Post post = Post.builder() + .title(request.title()) + .content(request.content()) + .user(user) + .build(); + post.setCreatedBy(user.getName()); + postRepository.save(post); + + return PostResponse.of( + post.getPostId(), + post.getTitle(), + post.getContent(), + post.getCreatedBy(), + post.getCreatedAt() + ); + } + + @Transactional(readOnly = true) + public PostsResponse getAllPost(int page) { + PageRequest pageRequest = PageRequest.of(page - 1, PAGE_SIZE); + + Page posts = postRepository.findAllByOrderByCreatedAtDesc(pageRequest); + + List postResponses = posts.stream() + .map(post -> PostResponse.of( + post.getPostId(), + post.getTitle(), + post.getContent(), + post.getCreatedBy(), + post.getCreatedAt() + )).toList(); + + PageInfo pageInfo = PageInfo.of(posts.getTotalPages(), posts.getNumber() + 1, posts.getTotalPages() == posts.getNumber() + 1); + + return PostsResponse.of(postResponses, pageInfo); + } + + @Transactional(readOnly = true) + public PostResponse getPost(Long postId) { + Post post = postRepository.findById(postId) + .orElseThrow(() -> new NotFoundException(Error.NOT_FOUND_POST_EXCEPTION, Error.NOT_FOUND_POST_EXCEPTION.getMessage())); + + return PostResponse.of( + post.getPostId(), + post.getTitle(), + post.getContent(), + post.getCreatedBy(), + post.getCreatedAt() + ); + } + + @Transactional + public PostResponse updatePost(UpdatePostRequest request, Long postId, Long userId) { + Post post = postRepository.findById(postId) + .orElseThrow(() -> new NotFoundException(Error.NOT_FOUND_POST_EXCEPTION, Error.NOT_FOUND_POST_EXCEPTION.getMessage())); + + if (post.getUser().getUserId() != userId) { + throw new UnauthorizedException(Error.UPDATE_POST_UNAUTHORIZED, Error.UPDATE_POST_UNAUTHORIZED.getMessage()); + } + + if (request.title() != null) { + post.updateTitle(request.title()); + } + + if (request.content() != null) { + post.updateContent(request.content()); + } + + return PostResponse.of( + post.getPostId(), + post.getTitle(), + post.getContent(), + post.getCreatedBy(), + post.getCreatedAt() + ); + } +} diff --git a/src/main/java/com/board/server/domain/user/entity/User.java b/src/main/java/com/board/server/domain/user/entity/User.java new file mode 100644 index 000000000..e9bfbb010 --- /dev/null +++ b/src/main/java/com/board/server/domain/user/entity/User.java @@ -0,0 +1,38 @@ +package com.board.server.domain.user.entity; + +import com.board.server.domain.post.entity.Post; +import com.board.server.global.common.dto.BaseEntity; +import jakarta.persistence.*; +import lombok.*; +import org.hibernate.annotations.DynamicInsert; + +import java.util.ArrayList; +import java.util.List; + +@Entity +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class User extends BaseEntity { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long userId; + + @Column(nullable = false) + private String name; + + @Column(nullable = false) + private int age; + + @Column + @Setter + private String hobby; + + @OneToMany(mappedBy = "user", cascade = CascadeType.ALL, orphanRemoval = true) + private List posts = new ArrayList<>(); + + @Builder + public User(String name, int age) { + this.name = name; + this.age = age; + } +} diff --git a/src/main/java/com/board/server/domain/user/entity/UserRepository.java b/src/main/java/com/board/server/domain/user/entity/UserRepository.java new file mode 100644 index 000000000..3cc8d05e7 --- /dev/null +++ b/src/main/java/com/board/server/domain/user/entity/UserRepository.java @@ -0,0 +1,14 @@ +package com.board.server.domain.user.entity; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface UserRepository extends JpaRepository { + // CREATE + + // READ + + // UPDATE + + // DELETE + +} diff --git a/src/main/java/com/board/server/global/common/advice/ControllerExceptionAdvice.java b/src/main/java/com/board/server/global/common/advice/ControllerExceptionAdvice.java new file mode 100644 index 000000000..0827f57b1 --- /dev/null +++ b/src/main/java/com/board/server/global/common/advice/ControllerExceptionAdvice.java @@ -0,0 +1,64 @@ +package com.board.server.global.common.advice; + +import com.board.server.global.common.dto.ApiResponse; +import com.board.server.global.exception.Error; +import com.board.server.global.exception.model.CustomException; +import lombok.RequiredArgsConstructor; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Component; +import org.springframework.validation.FieldError; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.MissingRequestHeaderException; +import org.springframework.web.bind.MissingServletRequestParameterException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +import java.util.Objects; + +@RestControllerAdvice +@Component +@RequiredArgsConstructor +public class ControllerExceptionAdvice { + /** + * 400 BAD_REQUEST + */ + + @ResponseStatus(HttpStatus.BAD_REQUEST) + @ExceptionHandler(MethodArgumentNotValidException.class) + protected ApiResponse handleMethodArgumentNotValidException(final MethodArgumentNotValidException e) { + FieldError fieldError = Objects.requireNonNull(e.getFieldError()); + return ApiResponse.error(Error.VALIDATION_REQUEST_MISSING_EXCEPTION, String.format("%s. (%s)", fieldError.getDefaultMessage(), fieldError.getField())); + } + + @ResponseStatus(HttpStatus.BAD_REQUEST) + @ExceptionHandler(MissingRequestHeaderException.class) + protected ApiResponse handleMissingRequestHeaderException(final MissingRequestHeaderException e) { + return ApiResponse.error(Error.VALIDATION_REQUEST_HEADER_MISSING_EXCEPTION, String.format("%s. (%s)", Error.VALIDATION_REQUEST_HEADER_MISSING_EXCEPTION.getMessage(), e.getHeaderName())); + } + + @ResponseStatus(HttpStatus.BAD_REQUEST) + @ExceptionHandler(MissingServletRequestParameterException.class) + protected ApiResponse handleMissingRequestParameterException(final MissingServletRequestParameterException e) { + return ApiResponse.error(Error.VALIDATION_REQUEST_PARAMETER_MISSING_EXCEPTION, String.format("%s. (%s)", Error.VALIDATION_REQUEST_PARAMETER_MISSING_EXCEPTION.getMessage(), e.getParameterName())); + } + + /** + * 500 Internal Server Error + */ + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + @ExceptionHandler(Exception.class) + protected ApiResponse handleException(final Exception error) { + return ApiResponse.error(Error.INTERNAL_SERVER_ERROR); + } + + /** + * custom error + */ + @ExceptionHandler(CustomException.class) + protected ResponseEntity handleSoptException(CustomException e) { + return ResponseEntity.status(e.getHttpStatus()) + .body(ApiResponse.error(e.getError(), e.getMessage())); + } +} diff --git a/src/main/java/com/board/server/global/common/dto/ApiResponse.java b/src/main/java/com/board/server/global/common/dto/ApiResponse.java new file mode 100644 index 000000000..aca2251da --- /dev/null +++ b/src/main/java/com/board/server/global/common/dto/ApiResponse.java @@ -0,0 +1,34 @@ +package com.board.server.global.common.dto; + +import com.board.server.global.exception.Error; +import com.board.server.global.exception.Success; +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +@Getter +@RequiredArgsConstructor(access = AccessLevel.PRIVATE) +@AllArgsConstructor(access = AccessLevel.PRIVATE) +public class ApiResponse { + + private final int code; + private final String message; + private T data; + + public static ApiResponse success(Success success) { + return new ApiResponse<>(success.getHttpStatusCode(), success.getMessage()); + } + + public static ApiResponse success(Success success, T data) { + return new ApiResponse(success.getHttpStatusCode(), success.getMessage(), data); + } + + public static ApiResponse error(Error error) { + return new ApiResponse<>(error.getHttpStatusCode(), error.getMessage()); + } + + public static ApiResponse error(Error error, String message) { + return new ApiResponse<>(error.getHttpStatusCode(), message); + } +} diff --git a/src/main/java/com/board/server/global/common/dto/BaseEntity.java b/src/main/java/com/board/server/global/common/dto/BaseEntity.java new file mode 100644 index 000000000..49336d691 --- /dev/null +++ b/src/main/java/com/board/server/global/common/dto/BaseEntity.java @@ -0,0 +1,23 @@ +package com.board.server.global.common.dto; + +import jakarta.persistence.Column; +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import lombok.Getter; +import lombok.Setter; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.LocalDateTime; + +@Getter +@MappedSuperclass +@EntityListeners(AuditingEntityListener.class) +public abstract class BaseEntity { + @CreatedDate + private LocalDateTime createdAt; + + @Column + @Setter + private String createdBy; +} diff --git a/src/main/java/com/board/server/global/exception/Error.java b/src/main/java/com/board/server/global/exception/Error.java new file mode 100644 index 000000000..e1a88b555 --- /dev/null +++ b/src/main/java/com/board/server/global/exception/Error.java @@ -0,0 +1,43 @@ +package com.board.server.global.exception; + +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor(access = AccessLevel.PRIVATE) +public enum Error { + /** + * 400 BAD REQUEST + */ + REQUEST_VALIDATION_EXCEPTION(HttpStatus.BAD_REQUEST, "잘못된 요청입니다"), + VALIDATION_REQUEST_MISSING_EXCEPTION(HttpStatus.BAD_REQUEST, "요청값이 입력되지 않았습니다."), + VALIDATION_REQUEST_HEADER_MISSING_EXCEPTION(HttpStatus.BAD_REQUEST, "요청 헤더값이 입력되지 않았습니다."), + VALIDATION_REQUEST_PARAMETER_MISSING_EXCEPTION(HttpStatus.BAD_REQUEST, "요청 파라미터값이 입력되지 않았습니다."), + PAGE_REQUEST_VALIDATION_EXCEPTION(HttpStatus.BAD_REQUEST, "페이지 넘버가 유효하지 않습니다."), + + /** + * 401 UNAUTHORIZED + */ + UPDATE_POST_UNAUTHORIZED(HttpStatus.UNAUTHORIZED, "게시글 수정 요청 권한이 없습니다."), + + /** + * 404 NOT FOUND + */ + NOT_FOUND_USER_EXCEPTION(HttpStatus.NOT_FOUND, "존재하지 않는 유저입니다"), + NOT_FOUND_POST_EXCEPTION(HttpStatus.NOT_FOUND, "존재하지 않는 게시글입니다"), + + /** + * 500 INTERNAL SERVER ERROR + */ + INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "알 수 없는 서버 에러가 발생했습니다"), + ; + + private final HttpStatus httpStatus; + private final String message; + + public int getHttpStatusCode() { + return httpStatus.value(); + } +} diff --git a/src/main/java/com/board/server/global/exception/Success.java b/src/main/java/com/board/server/global/exception/Success.java new file mode 100644 index 000000000..ee793638c --- /dev/null +++ b/src/main/java/com/board/server/global/exception/Success.java @@ -0,0 +1,30 @@ +package com.board.server.global.exception; + +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor(access = AccessLevel.PRIVATE) +public enum Success { + /** + * 200 OK + */ + GET_POST_LIST_SUCCESS(HttpStatus.OK, "게시글 전체 조회 성공"), + GET_POST_SUCCESS(HttpStatus.OK, "게시글 단일 조회 성공"), + UPDATE_POST_SUCCESS(HttpStatus.OK, "게시글 수정 성공"), + + /** + * 201 CREATED + */ + CREATE_POST_SUCCESS(HttpStatus.CREATED, "게시글 생성 성공"), + ; + + private final HttpStatus httpStatus; + private final String message; + + public int getHttpStatusCode() { + return httpStatus.value(); + } +} diff --git a/src/main/java/com/board/server/global/exception/model/BadRequestException.java b/src/main/java/com/board/server/global/exception/model/BadRequestException.java new file mode 100644 index 000000000..5d00d058f --- /dev/null +++ b/src/main/java/com/board/server/global/exception/model/BadRequestException.java @@ -0,0 +1,9 @@ +package com.board.server.global.exception.model; + +import com.board.server.global.exception.Error; + +public class BadRequestException extends CustomException { + public BadRequestException(Error error, String message) { + super(error, message); + } +} diff --git a/src/main/java/com/board/server/global/exception/model/CustomException.java b/src/main/java/com/board/server/global/exception/model/CustomException.java new file mode 100644 index 000000000..af5812caa --- /dev/null +++ b/src/main/java/com/board/server/global/exception/model/CustomException.java @@ -0,0 +1,19 @@ +package com.board.server.global.exception.model; + +import com.board.server.global.exception.Error; +import lombok.Getter; + +@Getter +public class CustomException extends RuntimeException { + + private final Error error; + + public CustomException(Error error, String message) { + super(message); + this.error = error; + } + + public int getHttpStatus() { + return error.getHttpStatusCode(); + } +} diff --git a/src/main/java/com/board/server/global/exception/model/NotFoundException.java b/src/main/java/com/board/server/global/exception/model/NotFoundException.java new file mode 100644 index 000000000..cf70c292e --- /dev/null +++ b/src/main/java/com/board/server/global/exception/model/NotFoundException.java @@ -0,0 +1,9 @@ +package com.board.server.global.exception.model; + +import com.board.server.global.exception.Error; + +public class NotFoundException extends CustomException { + public NotFoundException(Error error, String message) { + super(error, message); + } +} \ No newline at end of file diff --git a/src/main/java/com/board/server/global/exception/model/UnauthorizedException.java b/src/main/java/com/board/server/global/exception/model/UnauthorizedException.java new file mode 100644 index 000000000..ed6750e5c --- /dev/null +++ b/src/main/java/com/board/server/global/exception/model/UnauthorizedException.java @@ -0,0 +1,9 @@ +package com.board.server.global.exception.model; + +import com.board.server.global.exception.Error; + +public class UnauthorizedException extends CustomException { + public UnauthorizedException(Error error, String message) { + super(error, message); + } +} diff --git a/src/test/java/com/board/server/ServerApplicationTests.java b/src/test/java/com/board/server/ServerApplicationTests.java new file mode 100644 index 000000000..8a944d9d4 --- /dev/null +++ b/src/test/java/com/board/server/ServerApplicationTests.java @@ -0,0 +1,13 @@ +package com.board.server; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class ServerApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/com/board/server/domain/post/controller/PostControllerTest.java b/src/test/java/com/board/server/domain/post/controller/PostControllerTest.java new file mode 100644 index 000000000..f889a9c49 --- /dev/null +++ b/src/test/java/com/board/server/domain/post/controller/PostControllerTest.java @@ -0,0 +1,171 @@ +package com.board.server.domain.post.controller; + +import com.board.server.domain.post.dto.request.CreatePostRequest; +import com.board.server.domain.post.dto.request.UpdatePostRequest; +import com.board.server.domain.post.entity.Post; +import com.board.server.domain.post.entity.PostRepository; +import com.board.server.domain.post.service.PostService; +import com.board.server.domain.user.entity.User; +import com.board.server.domain.user.entity.UserRepository; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +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.MediaType; +import org.springframework.restdocs.payload.JsonFieldType; +import org.springframework.test.web.servlet.MockMvc; + +import static org.junit.jupiter.api.Assertions.*; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.payload.PayloadDocumentation.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@AutoConfigureRestDocs +@AutoConfigureMockMvc +@SpringBootTest +class PostControllerTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + private PostService postService; + + @Autowired + private PostRepository postRepository; + + @Autowired + private UserRepository userRepository; + + @Autowired + ObjectMapper objectMapper; + + User user1; + Post post1; + + @BeforeEach + void setUp() { + user1 = User.builder() + .name("밍키") + .age(19).build(); + user1.setHobby("공놀이"); + + userRepository.save(user1); + + CreatePostRequest createPostRequest = new CreatePostRequest("제목1", "내용1"); + Long postId = postService.createPost(createPostRequest, user1.getUserId()).postId(); + post1 = postRepository.findById(postId).get(); + } + + @AfterEach + void tearDown() { + postRepository.deleteAll(); + userRepository.deleteAll(); + } + + @Test + void saveTest() throws Exception { + CreatePostRequest createPostRequest = new CreatePostRequest("제목test", "내용test"); + + mockMvc.perform(post("/posts") + .header("userId", user1.getUserId()) + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(createPostRequest))) + .andExpect(status().isCreated()) + .andDo(print()) + .andDo(document("post-save", + requestFields( + fieldWithPath("title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("content").type(JsonFieldType.STRING).description("content") + ), + responseFields( + fieldWithPath("code").type(JsonFieldType.NUMBER).description("상태코드"), + fieldWithPath("message").type(JsonFieldType.STRING).description("응답 메세지"), + fieldWithPath("data").type(JsonFieldType.OBJECT).description("데이터"), + fieldWithPath("data.postId").type(JsonFieldType.NUMBER).description("postId"), + fieldWithPath("data.title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("data.content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("data.createdBy").type(JsonFieldType.STRING).description("createdBy"), + fieldWithPath("data.createdAt").type(JsonFieldType.STRING).description("createdAt") + ) + )); + } + + @Test + void getAllPostTest() throws Exception { + mockMvc.perform(get("/posts") + .param("page", String.valueOf(1))) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("get-all-post", + responseFields( + fieldWithPath("code").type(JsonFieldType.NUMBER).description("상태코드"), + fieldWithPath("message").type(JsonFieldType.STRING).description("응답 메세지"), + fieldWithPath("data").type(JsonFieldType.OBJECT).description("데이터"), + fieldWithPath("data.postResponses").type(JsonFieldType.ARRAY).description("게시글 리스트"), + fieldWithPath("data.postResponses[].postId").type(JsonFieldType.NUMBER).description("postId"), + fieldWithPath("data.postResponses[].title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("data.postResponses[].content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("data.postResponses[].createdBy").type(JsonFieldType.STRING).description("createdBy"), + fieldWithPath("data.postResponses[].createdAt").type(JsonFieldType.STRING).description("createdAt"), + fieldWithPath("data.pageInfo").type(JsonFieldType.OBJECT).description("페이지 정보 조회"), + fieldWithPath("data.pageInfo.totalPageSize").type(JsonFieldType.NUMBER).description("총 페이지 수"), + fieldWithPath("data.pageInfo.currentPageIndex").type(JsonFieldType.NUMBER).description("현재 페이지"), + fieldWithPath("data.pageInfo.isEnd").type(JsonFieldType.BOOLEAN).description("마지막 페이지 여부") + ) + )); + } + + @Test + void getOnePostTest() throws Exception { + mockMvc.perform(get("/posts/{postId}", post1.getPostId())) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("get-one-post", + responseFields( + fieldWithPath("code").type(JsonFieldType.NUMBER).description("상태코드"), + fieldWithPath("code").type(JsonFieldType.NUMBER).description("상태코드"), + fieldWithPath("message").type(JsonFieldType.STRING).description("응답 메세지"), + fieldWithPath("data").type(JsonFieldType.OBJECT).description("데이터"), + fieldWithPath("data.postId").type(JsonFieldType.NUMBER).description("postId"), + fieldWithPath("data.title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("data.content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("data.createdBy").type(JsonFieldType.STRING).description("createdBy"), + fieldWithPath("data.createdAt").type(JsonFieldType.STRING).description("createdAt") + ) + )); + } + + @Test + void updatePostTest() throws Exception { + UpdatePostRequest updatePostRequest = new UpdatePostRequest("바뀐 제목", null); + + mockMvc.perform(patch("/posts/{postId}", post1.getPostId()) + .header("userId", post1.getUser().getUserId()) + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(updatePostRequest))) + .andExpect(status().isOk()) + .andDo(print()) + .andDo(document("update-post", + responseFields( + fieldWithPath("code").type(JsonFieldType.NUMBER).description("상태코드"), + fieldWithPath("code").type(JsonFieldType.NUMBER).description("상태코드"), + fieldWithPath("message").type(JsonFieldType.STRING).description("응답 메세지"), + fieldWithPath("data").type(JsonFieldType.OBJECT).description("데이터"), + fieldWithPath("data.postId").type(JsonFieldType.NUMBER).description("postId"), + fieldWithPath("data.title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("data.content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("data.createdBy").type(JsonFieldType.STRING).description("createdBy"), + fieldWithPath("data.createdAt").type(JsonFieldType.STRING).description("createdAt") + ) + )); + } + +} \ No newline at end of file diff --git a/src/test/java/com/board/server/domain/post/service/PostServiceTest.java b/src/test/java/com/board/server/domain/post/service/PostServiceTest.java new file mode 100644 index 000000000..4f6534435 --- /dev/null +++ b/src/test/java/com/board/server/domain/post/service/PostServiceTest.java @@ -0,0 +1,85 @@ +package com.board.server.domain.post.service; + +import com.board.server.domain.post.dto.request.CreatePostRequest; +import com.board.server.domain.post.dto.request.UpdatePostRequest; +import com.board.server.domain.post.dto.response.PostResponse; +import com.board.server.domain.post.entity.Post; +import com.board.server.domain.post.entity.PostRepository; +import com.board.server.domain.user.entity.User; +import com.board.server.domain.user.entity.UserRepository; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; + +import static org.junit.jupiter.api.Assertions.*; +import static org.assertj.core.api.Assertions.assertThat; + +@SpringBootTest +class PostServiceTest { + @Autowired + private PostService postService; + + @Autowired + private PostRepository postRepository; + + @Autowired + private UserRepository userRepository; + + User user1; + Post post1; + + @BeforeEach + void setUp() { + user1 = User.builder() + .name("밍키") + .age(19).build(); + user1.setHobby("공놀이"); + + userRepository.save(user1); + + CreatePostRequest createPostRequest = new CreatePostRequest("제목1", "내용1"); + Long postId = postService.createPost(createPostRequest, user1.getUserId()).postId(); + post1 = postRepository.findById(postId).get(); + } + + @AfterEach + void tearDown() { + postRepository.deleteAll(); + userRepository.deleteAll(); + } + + @Test + void createPostTest() { + CreatePostRequest createPostRequest = new CreatePostRequest("제목test", "내용test"); + PostResponse postResponse = postService.createPost(createPostRequest, user1.getUserId()); + + Post saved = postRepository.findById(postResponse.postId()) + .orElse(null); + + assertThat(saved).isNotNull(); + assertThat(saved.getTitle()).isEqualTo("제목test"); + assertThat(saved.getContent()).isEqualTo("내용test"); + } + + @Test + void getOnePostTest() { + PostResponse postResponse = postService.getPost(post1.getPostId()); + + assertThat(postResponse.postId()).isEqualTo(post1.getPostId()); + assertThat(postResponse.title()).isEqualTo("제목1"); + assertThat(postResponse.content()).isEqualTo("내용1"); + assertThat(postResponse.createdBy()).isEqualTo(user1.getName()); + } + + @Test + void updatePostTest() { + UpdatePostRequest request = new UpdatePostRequest("바뀐 제목", "바뀐 내용"); + postService.updatePost(request, post1.getPostId(), user1.getUserId()); + Post updated = postRepository.findById(post1.getPostId()).get(); + + assertThat(updated.getTitle()).isEqualTo("바뀐 제목"); + assertThat(updated.getContent()).isEqualTo("바뀐 내용"); + } +} \ No newline at end of file