diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..4cddf1940 --- /dev/null +++ b/.gitignore @@ -0,0 +1,99 @@ +# Default ignored files +/shelf/ +/.idea/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml + +# Created by https://www.toptal.com/developers/gitignore/api/gradle,java,macos +# Edit at https://www.toptal.com/developers/gitignore?templates=gradle,java,macos + +### Java ### +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar +.idea +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* +replay_pid* + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### macOS Patch ### +# iCloud generated files +*.icloud + +### Gradle ### +.gradle +**/build/ +!src/**/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 + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath + +### Gradle Patch ### +# Java heap dump +*.hprof + +# End of https://www.toptal.com/developers/gitignore/api/gradle,java,macos diff --git a/build.gradle b/build.gradle new file mode 100644 index 000000000..ec2c0f02e --- /dev/null +++ b/build.gradle @@ -0,0 +1,48 @@ +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.programmers' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +ext { + set('snippetsDir', file("build/generated-snippets")) +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-validation' + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.h2database:h2' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc' +} + +tasks.named('test') { + outputs.dir snippetsDir + useJUnitPlatform() +} + +tasks.named('asciidoctor') { + inputs.dir snippetsDir + dependsOn test +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..249e5832f 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..ae04661ee --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 000000000..a69d9cb6c --- /dev/null +++ b/gradlew @@ -0,0 +1,240 @@ +#!/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/master/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 + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# 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"' + +# 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 + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + 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 + +# 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..f127cfd49 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,91 @@ +@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=. +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..0795530c5 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'springboot-board-jpa' diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc new file mode 100644 index 000000000..c726f07fa --- /dev/null +++ b/src/docs/asciidoc/index.adoc @@ -0,0 +1,33 @@ += 게시판 REST API +ifndef::snippets[] +:snippets: build/generated-snippets +endif::[] + +== 게시글 작성 +.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[] + +== 게시글 조회 +.Request +include::{snippets}/post-find/http-request.adoc[] +.Response +include::{snippets}/post-find/http-response.adoc[] +include::{snippets}/post-find/response-fields.adoc[] + +== 게시글 전체 조회 +.Request +include::{snippets}/posts-find/http-request.adoc[] +.Response +include::{snippets}/posts-find/http-response.adoc[] +include::{snippets}/posts-find/response-fields.adoc[] + +== 게시글 수정 +.Request +include::{snippets}/post-update/http-request.adoc[] +.Response +include::{snippets}/post-update/http-response.adoc[] +include::{snippets}/post-update/response-fields.adoc[] diff --git a/src/main/java/com/programmers/Main.java b/src/main/java/com/programmers/Main.java new file mode 100644 index 000000000..4e30558c2 --- /dev/null +++ b/src/main/java/com/programmers/Main.java @@ -0,0 +1,14 @@ +package com.programmers; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@EnableJpaAuditing +@SpringBootApplication +public class Main { + public static void main(String[] args) { + SpringApplication.run(Main.class, args); + } + +} diff --git a/src/main/java/com/programmers/common/dto/ApiIdResponse.java b/src/main/java/com/programmers/common/dto/ApiIdResponse.java new file mode 100644 index 000000000..51b96c132 --- /dev/null +++ b/src/main/java/com/programmers/common/dto/ApiIdResponse.java @@ -0,0 +1,4 @@ +package com.programmers.common.dto; + +public record ApiIdResponse(Long id) { +} diff --git a/src/main/java/com/programmers/config/AuditorAwareConfig.java b/src/main/java/com/programmers/config/AuditorAwareConfig.java new file mode 100644 index 000000000..18ca8078c --- /dev/null +++ b/src/main/java/com/programmers/config/AuditorAwareConfig.java @@ -0,0 +1,17 @@ +package com.programmers.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.domain.AuditorAware; + +import java.util.Optional; +import java.util.UUID; + +@Configuration +public class AuditorAwareConfig { + + @Bean + public AuditorAware auditorProvider() { + return () -> Optional.of(UUID.randomUUID().toString()); + } +} diff --git a/src/main/java/com/programmers/domain/base/BaseEntity.java b/src/main/java/com/programmers/domain/base/BaseEntity.java new file mode 100644 index 000000000..eeb37d3ab --- /dev/null +++ b/src/main/java/com/programmers/domain/base/BaseEntity.java @@ -0,0 +1,23 @@ +package com.programmers.domain.base; + +import jakarta.persistence.Column; +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import org.springframework.data.annotation.CreatedBy; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.LocalDateTime; + +@EntityListeners(AuditingEntityListener.class) +@MappedSuperclass +public abstract class BaseEntity { + + @CreatedBy + @Column(name = "created_by", updatable = false) + private String createdBy; + + @CreatedDate + @Column(name = "created_at", columnDefinition = "TIMESTAMP(6)", updatable = false) + private LocalDateTime createdAt; +} diff --git a/src/main/java/com/programmers/domain/post/application/PostService.java b/src/main/java/com/programmers/domain/post/application/PostService.java new file mode 100644 index 000000000..12fb8ff1a --- /dev/null +++ b/src/main/java/com/programmers/domain/post/application/PostService.java @@ -0,0 +1,19 @@ +package com.programmers.domain.post.application; + +import com.programmers.domain.post.ui.dto.PostCreateDto; +import com.programmers.domain.post.ui.dto.PostResponseDto; +import com.programmers.domain.post.ui.dto.PostUpdateDto; +import org.springframework.data.domain.Pageable; + +import java.util.List; + +public interface PostService { + + Long createPost(PostCreateDto postCreateDto); + + PostResponseDto findPost(Long postId); + + List findAll(Pageable pageable); + + PostResponseDto updatePost(PostUpdateDto postUpdateDto, Long postId); +} diff --git a/src/main/java/com/programmers/domain/post/application/PostServiceImpl.java b/src/main/java/com/programmers/domain/post/application/PostServiceImpl.java new file mode 100644 index 000000000..6563aaa9a --- /dev/null +++ b/src/main/java/com/programmers/domain/post/application/PostServiceImpl.java @@ -0,0 +1,63 @@ +package com.programmers.domain.post.application; + +import com.programmers.domain.post.application.converter.PostConverter; +import com.programmers.domain.post.entity.Post; +import com.programmers.domain.post.infra.PostRepository; +import com.programmers.domain.post.ui.dto.PostCreateDto; +import com.programmers.domain.post.ui.dto.PostResponseDto; +import com.programmers.domain.post.ui.dto.PostUpdateDto; +import com.programmers.domain.user.entity.User; +import com.programmers.domain.user.infra.UserRepository; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.util.List; +import java.util.NoSuchElementException; + +@Service +@RequiredArgsConstructor +@Transactional(readOnly = true) +public class PostServiceImpl implements PostService{ + + private static final String USER_NOT_FOUND = "유저를 찾을 수 없습니다. {} "; + private static final String POST_NOT_FOUND = "게시글을 찾을 수 없습니다. {} "; + private final PostRepository postRepository; + private final UserRepository userRepository; + private final PostConverter postConverter; + + @Override + @Transactional + public Long createPost(PostCreateDto postCreateDto) { + User user = userRepository.findById(postCreateDto.userId()) + .orElseThrow(() -> new NoSuchElementException(String.format(USER_NOT_FOUND, postCreateDto.userId()))); + Post post = postConverter.convertPost(postCreateDto, user); + Post savedPost = postRepository.save(post); + return savedPost.getId(); + } + + @Override + public PostResponseDto findPost(Long postId) { + Post post = postRepository.findById(postId) + .orElseThrow(() -> new NoSuchElementException(String.format(POST_NOT_FOUND, postId))); + return postConverter.convertEntityToPostResponseDto(post); + } + + @Override + public List findAll(Pageable pageable) { + return postRepository.findAll(pageable) + .stream() + .map(postConverter::convertEntityToPostResponseDto) + .toList(); + } + + @Override + @Transactional + public PostResponseDto updatePost(PostUpdateDto postUpdateDto, Long postId) { + Post post = postRepository.findById(postId) + .orElseThrow(() -> new NoSuchElementException(String.format(POST_NOT_FOUND, postId))); + post.changeTitleAndContent(postUpdateDto.title(), postUpdateDto.content()); + return postConverter.convertEntityToPostResponseDto(post); + } +} diff --git a/src/main/java/com/programmers/domain/post/application/converter/PostConverter.java b/src/main/java/com/programmers/domain/post/application/converter/PostConverter.java new file mode 100644 index 000000000..f6ce493d2 --- /dev/null +++ b/src/main/java/com/programmers/domain/post/application/converter/PostConverter.java @@ -0,0 +1,23 @@ +package com.programmers.domain.post.application.converter; + +import com.programmers.domain.post.entity.Post; +import com.programmers.domain.post.ui.dto.PostCreateDto; +import com.programmers.domain.post.ui.dto.PostResponseDto; +import com.programmers.domain.user.entity.User; +import org.springframework.stereotype.Component; + +@Component +public class PostConverter { + + public Post convertPost(PostCreateDto postCreateDto, User user) { + return new Post(postCreateDto.title(), postCreateDto.content(), user); + } + + public PostCreateDto convertPostDto(Post post) { + return new PostCreateDto(post.getTitle(), post.getContent(), post.getUser().getId()); + } + + public PostResponseDto convertEntityToPostResponseDto(Post post){ + return new PostResponseDto(post.getId(), post.getTitle(), post.getContent(), post.getUser().getId()); + } +} diff --git a/src/main/java/com/programmers/domain/post/entity/Post.java b/src/main/java/com/programmers/domain/post/entity/Post.java new file mode 100644 index 000000000..65feb9e72 --- /dev/null +++ b/src/main/java/com/programmers/domain/post/entity/Post.java @@ -0,0 +1,74 @@ +package com.programmers.domain.post.entity; + +import com.programmers.domain.base.BaseEntity; +import com.programmers.domain.user.entity.User; +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.Lob; +import jakarta.persistence.ManyToOne; +import jakarta.persistence.Table; +import lombok.AccessLevel; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.util.Objects; + +@Entity +@Table(name = "posts") +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +@EqualsAndHashCode +public class Post extends BaseEntity { + + private static final int MAX_TITLE_LENGTH = 50; + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @Column(length = MAX_TITLE_LENGTH, nullable = false) + private String title; + + @Lob + @Column(nullable = false) + private String content; + + @ManyToOne + @JoinColumn(name = "users_id") + private User user; + + public Post(String title, String content, User user) { + validateTitle(title); + validateContent(content); + this.title = title; + this.content = content; + this.user = user; + } + + private static void validateContent(String content) { + if (Objects.isNull(content) || content.isBlank()) { + throw new IllegalArgumentException("본문이 비어있습니다."); + } + } + + private static void validateTitle(String title) { + if (Objects.isNull(title) || title.isBlank()) { + throw new IllegalArgumentException("제목이 비어있습니다."); + } + if (title.length() > MAX_TITLE_LENGTH) { + throw new IllegalArgumentException(String.format("제목 길이가 최대 길이 %s 자를 넘었습니다.", MAX_TITLE_LENGTH)); + } + } + + public void changeTitleAndContent(String title, String content) { + validateTitle(title); + validateContent(content); + this.title = title; + this.content = content; + } +} diff --git a/src/main/java/com/programmers/domain/post/infra/PostRepository.java b/src/main/java/com/programmers/domain/post/infra/PostRepository.java new file mode 100644 index 000000000..05263c323 --- /dev/null +++ b/src/main/java/com/programmers/domain/post/infra/PostRepository.java @@ -0,0 +1,9 @@ +package com.programmers.domain.post.infra; + +import com.programmers.domain.post.entity.Post; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface PostRepository extends JpaRepository { +} diff --git a/src/main/java/com/programmers/domain/post/ui/PostController.java b/src/main/java/com/programmers/domain/post/ui/PostController.java new file mode 100644 index 000000000..213b44c4f --- /dev/null +++ b/src/main/java/com/programmers/domain/post/ui/PostController.java @@ -0,0 +1,51 @@ +package com.programmers.domain.post.ui; + +import com.programmers.common.dto.ApiIdResponse; +import com.programmers.domain.post.application.PostService; +import com.programmers.domain.post.ui.dto.PostCreateDto; +import com.programmers.domain.post.ui.dto.PostResponseDto; +import com.programmers.domain.post.ui.dto.PostUpdateDto; +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.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PatchMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestController; + +import java.util.List; + +@RestController +@RequiredArgsConstructor +@RequestMapping("/api/posts") +public class PostController { + + private final PostService postService; + + @ResponseStatus(HttpStatus.CREATED) + @PostMapping + public ApiIdResponse createPost(@RequestBody PostCreateDto postCreateDto) { + return new ApiIdResponse(postService.createPost(postCreateDto)); + } + + @GetMapping + public List findPostList(@PageableDefault(size = 20, sort = "id", direction = Sort.Direction.DESC) Pageable pageable) { + return postService.findAll(pageable); + } + + @GetMapping("/{id}") + public PostResponseDto findPost(@PathVariable Long id) { + return postService.findPost(id); + } + + @PatchMapping("/{id}") + public PostResponseDto updatePost(@PathVariable Long id, @RequestBody PostUpdateDto postUpdateDto) { + return postService.updatePost(postUpdateDto, id); + } +} diff --git a/src/main/java/com/programmers/domain/post/ui/dto/PostCreateDto.java b/src/main/java/com/programmers/domain/post/ui/dto/PostCreateDto.java new file mode 100644 index 000000000..780784c00 --- /dev/null +++ b/src/main/java/com/programmers/domain/post/ui/dto/PostCreateDto.java @@ -0,0 +1,4 @@ +package com.programmers.domain.post.ui.dto; + +public record PostCreateDto(String title, String content, Long userId) { +} diff --git a/src/main/java/com/programmers/domain/post/ui/dto/PostResponseDto.java b/src/main/java/com/programmers/domain/post/ui/dto/PostResponseDto.java new file mode 100644 index 000000000..3e2b0172f --- /dev/null +++ b/src/main/java/com/programmers/domain/post/ui/dto/PostResponseDto.java @@ -0,0 +1,9 @@ +package com.programmers.domain.post.ui.dto; + +public record PostResponseDto ( + Long postId, + String title, + String content, + Long userId +){ +} diff --git a/src/main/java/com/programmers/domain/post/ui/dto/PostUpdateDto.java b/src/main/java/com/programmers/domain/post/ui/dto/PostUpdateDto.java new file mode 100644 index 000000000..6353bb5a6 --- /dev/null +++ b/src/main/java/com/programmers/domain/post/ui/dto/PostUpdateDto.java @@ -0,0 +1,4 @@ +package com.programmers.domain.post.ui.dto; + +public record PostUpdateDto(String title, String content) { +} diff --git a/src/main/java/com/programmers/domain/user/application/UserService.java b/src/main/java/com/programmers/domain/user/application/UserService.java new file mode 100644 index 000000000..acd815cac --- /dev/null +++ b/src/main/java/com/programmers/domain/user/application/UserService.java @@ -0,0 +1,10 @@ +package com.programmers.domain.user.application; + +import com.programmers.domain.user.ui.dto.UserDto; + +public interface UserService { + + Long createUser(UserDto userDto); + + UserDto findUser(Long userId); +} diff --git a/src/main/java/com/programmers/domain/user/application/UserServiceImpl.java b/src/main/java/com/programmers/domain/user/application/UserServiceImpl.java new file mode 100644 index 000000000..46bfb487b --- /dev/null +++ b/src/main/java/com/programmers/domain/user/application/UserServiceImpl.java @@ -0,0 +1,36 @@ +package com.programmers.domain.user.application; + +import com.programmers.domain.user.application.converter.UserConverter; +import com.programmers.domain.user.entity.User; +import com.programmers.domain.user.infra.UserRepository; +import com.programmers.domain.user.ui.dto.UserDto; +import lombok.RequiredArgsConstructor; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.util.NoSuchElementException; + +@Service +@Transactional(readOnly = true) +@RequiredArgsConstructor +public class UserServiceImpl implements UserService{ + + private static final String USER_NOT_FOUND = "유저를 찾을 수 없습니다. {} "; + private final UserRepository userRepository; + private final UserConverter userConverter; + + @Override + @Transactional + public Long createUser(UserDto userDto) { + User user = userConverter.convertUser(userDto); + User savedUser = userRepository.save(user); + return savedUser.getId(); + } + + @Override + public UserDto findUser(Long userId) { + User user = userRepository.findById(userId) + .orElseThrow(() -> new NoSuchElementException(String.format(USER_NOT_FOUND, userId))); + return userConverter.convertUserDto(user); + } +} diff --git a/src/main/java/com/programmers/domain/user/application/converter/UserConverter.java b/src/main/java/com/programmers/domain/user/application/converter/UserConverter.java new file mode 100644 index 000000000..c0258bd7d --- /dev/null +++ b/src/main/java/com/programmers/domain/user/application/converter/UserConverter.java @@ -0,0 +1,17 @@ +package com.programmers.domain.user.application.converter; + +import com.programmers.domain.user.entity.User; +import com.programmers.domain.user.ui.dto.UserDto; +import org.springframework.stereotype.Component; + +@Component +public class UserConverter { + + public User convertUser(UserDto userDto) { + return new User(userDto.name(), userDto.age(), userDto.hobby()); + } + + public UserDto convertUserDto(User user) { + return new UserDto(user.getName(), user.getAge(), user.getHobby()); + } +} diff --git a/src/main/java/com/programmers/domain/user/entity/User.java b/src/main/java/com/programmers/domain/user/entity/User.java new file mode 100644 index 000000000..70d5547cc --- /dev/null +++ b/src/main/java/com/programmers/domain/user/entity/User.java @@ -0,0 +1,71 @@ +package com.programmers.domain.user.entity; + +import com.programmers.domain.base.BaseEntity; +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 lombok.AccessLevel; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.util.Objects; + +@Entity +@Table(name = "users") +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) +@EqualsAndHashCode +public class User extends BaseEntity { + + private static final int MAX_HOBBY_LENGTH = 100; + private static final int MAX_NAME_LENGTH = 5; + + @Id @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @Column(length = MAX_NAME_LENGTH, nullable = false) + private String name; + + @Column(nullable = false) + private int age; + + @Column(length = MAX_HOBBY_LENGTH, nullable = false) + private String hobby; + + public User(String name, int age, String hobby) { + validateName(name); + validateAge(age); + validateHobby(hobby); + this.name = name; + this.age = age; + this.hobby = hobby; + } + + private static void validateHobby(String hobby) { + if (Objects.isNull(hobby) || hobby.isBlank()) { + throw new IllegalArgumentException("취미가 비어있습니다."); + } + if (hobby.length() > MAX_HOBBY_LENGTH) { + throw new IllegalArgumentException(String.format("취미 길이가 %s를 넘었습니다. 입력값: %s", MAX_HOBBY_LENGTH, hobby.length())); + } + } + + private static void validateAge(int age) { + if (age < 0) { + throw new IllegalArgumentException(String.format("나이가 0보다 작습니다. 입력값: %s", age)); + } + } + + private static void validateName(String name) { + if (Objects.isNull(name) || name.isBlank()) { + throw new IllegalArgumentException("이름이 비어있습니다."); + } + if (name.length() > MAX_NAME_LENGTH) { + throw new IllegalArgumentException(String.format("이름 길이가 %s를 넘었습니다. 입력값: %s", MAX_NAME_LENGTH, name.length())); + } + } +} diff --git a/src/main/java/com/programmers/domain/user/infra/UserRepository.java b/src/main/java/com/programmers/domain/user/infra/UserRepository.java new file mode 100644 index 000000000..ec459ac03 --- /dev/null +++ b/src/main/java/com/programmers/domain/user/infra/UserRepository.java @@ -0,0 +1,9 @@ +package com.programmers.domain.user.infra; + +import com.programmers.domain.user.entity.User; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface UserRepository extends JpaRepository { +} diff --git a/src/main/java/com/programmers/domain/user/ui/dto/UserDto.java b/src/main/java/com/programmers/domain/user/ui/dto/UserDto.java new file mode 100644 index 000000000..56539459e --- /dev/null +++ b/src/main/java/com/programmers/domain/user/ui/dto/UserDto.java @@ -0,0 +1,4 @@ +package com.programmers.domain.user.ui.dto; + +public record UserDto(String name, int age, String hobby) { +} diff --git a/src/main/java/com/programmers/exception/ApiExceptionHandler.java b/src/main/java/com/programmers/exception/ApiExceptionHandler.java new file mode 100644 index 000000000..028ee0db2 --- /dev/null +++ b/src/main/java/com/programmers/exception/ApiExceptionHandler.java @@ -0,0 +1,32 @@ +package com.programmers.exception; + +import org.springframework.http.HttpStatus; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +import java.util.NoSuchElementException; + +@RestControllerAdvice +public class ApiExceptionHandler { + + private static final String INTERNAL_SERVER_ERROR_MESSAGE = "서버 에러"; + + @ExceptionHandler(Exception.class) + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + private ErrorResult handleException() { + return new ErrorResult(HttpStatus.INTERNAL_SERVER_ERROR.value(), INTERNAL_SERVER_ERROR_MESSAGE); + } + + @ExceptionHandler(IllegalArgumentException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + private ErrorResult handleIllegalArgumentException(IllegalArgumentException e) { + return new ErrorResult(HttpStatus.BAD_REQUEST.value(), e.getMessage()); + } + + @ExceptionHandler(NoSuchElementException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + private ErrorResult handleNoSuchElementException(NoSuchElementException e) { + return new ErrorResult(HttpStatus.BAD_REQUEST.value(), e.getMessage()); + } +} diff --git a/src/main/java/com/programmers/exception/ErrorResult.java b/src/main/java/com/programmers/exception/ErrorResult.java new file mode 100644 index 000000000..59154ad09 --- /dev/null +++ b/src/main/java/com/programmers/exception/ErrorResult.java @@ -0,0 +1,4 @@ +package com.programmers.exception; + +public record ErrorResult(int errorCode, String errorMessage) { +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 000000000..d727ffcd2 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,23 @@ +spring: + datasource: + driver-class-name: org.h2.Driver + url: jdbc:h2:~/board;DB_CLOSE_ON_EXIT=FALSE + username: sa + password: + jpa: + open-in-view: false + hibernate: + ddl-auto: create-drop + properties: + hibernate: + format_sql: true + show_sql: true + h2: + console: + enabled: true +server: + servlet: + encoding: + charset: UTF-8 + enabled: true + force: true diff --git a/src/test/java/com/programmers/domain/post/application/PostServiceImplTest.java b/src/test/java/com/programmers/domain/post/application/PostServiceImplTest.java new file mode 100644 index 000000000..654eae634 --- /dev/null +++ b/src/test/java/com/programmers/domain/post/application/PostServiceImplTest.java @@ -0,0 +1,142 @@ +package com.programmers.domain.post.application; + +import com.programmers.domain.post.application.converter.PostConverter; +import com.programmers.domain.post.entity.Post; +import com.programmers.domain.post.infra.PostRepository; +import com.programmers.domain.post.ui.dto.PostCreateDto; +import com.programmers.domain.post.ui.dto.PostResponseDto; +import com.programmers.domain.post.ui.dto.PostUpdateDto; +import com.programmers.domain.user.entity.User; +import com.programmers.domain.user.infra.UserRepository; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.BDDMockito; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.data.domain.PageImpl; +import org.springframework.data.domain.PageRequest; +import org.springframework.data.domain.Sort; +import org.springframework.test.util.ReflectionTestUtils; + +import java.util.List; +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; + +@ExtendWith(MockitoExtension.class) +class PostServiceImplTest { + + private PostService postService; + private PostConverter postConverter; + + @Mock + private UserRepository userRepository; + + @Mock + private PostRepository postRepository; + + @BeforeEach + void setUp() { + postConverter = new PostConverter(); + postService = new PostServiceImpl(postRepository, userRepository, postConverter); + } + + @Test + void createPost() { + //given + final Long expectedPostId = 1l; + + final Long fakeUserId = 1l; + final Long fakePostId = 1l; + + PostCreateDto postCreateDto = new PostCreateDto("제목", "본문", fakeUserId); + User user = new User("명한", 1, "운동"); + Post post = new Post("제목", "본문", user); + + Post savedPost = new Post("제목", "본문", user); + ReflectionTestUtils.setField(savedPost, "id", fakePostId); + + BDDMockito.given(userRepository.findById(fakeUserId)).willReturn(Optional.of(user)); + BDDMockito.given(postRepository.save(post)).willReturn(savedPost); + + //when + Long savedPostId = postService.createPost(postCreateDto); + + //then + assertThat(savedPostId).isEqualTo(expectedPostId); + } + + @Test + void findPost() { + //given + final Long expectedPostId = 1l; + + final Long fakeUserId = 1l; + final Long fakePostId = 1l; + + User user = new User("명한", 1, "운동"); + ReflectionTestUtils.setField(user, "id", fakeUserId); + Post post = new Post("제목", "본문", user); + Post savedPost = new Post("제목", "본문", user); + ReflectionTestUtils.setField(savedPost, "id", fakePostId); + + BDDMockito.given(postRepository.findById(fakePostId)).willReturn(Optional.of(savedPost)); + + //when + PostResponseDto foundPost = postService.findPost(fakePostId); + + //then + assertThat(foundPost.postId()).isEqualTo(expectedPostId); + } + + @Test + void findAll() { + // given + final int expectedCount = 2; + + final Long fakeUserId = 1l; + final Long fakePostId1 = 1l; + final Long fakePostId2 = 2l; + + User user = new User("명한", 1, "운동"); + ReflectionTestUtils.setField(user, "id", fakeUserId); + Post post1 = new Post("제목1", "본문1", user); + ReflectionTestUtils.setField(post1, "id", fakePostId1); + Post post2 = new Post("제목2", "본문2", user); + ReflectionTestUtils.setField(post2, "id", fakePostId2); + + PageRequest pageRequest = PageRequest.of(0, 20, Sort.by(Sort.Direction.DESC, "id")); + PageImpl posts = new PageImpl<>(List.of(post1, post2)); + BDDMockito.given(postRepository.findAll(pageRequest)).willReturn(posts); + + // when + List postList = postService.findAll(pageRequest); + + // then + assertThat(postList).hasSize(expectedCount); + } + + @Test + void updatePost() { + // given + final Long fakeUserId = 1l; + final Long fakePostId = 1l; + + User user = new User("명한", 1, "운동"); + ReflectionTestUtils.setField(user, "id", fakeUserId); + Post post = new Post("제목", "본문", user); + ReflectionTestUtils.setField(post, "id", fakePostId); + + PostUpdateDto postUpdateDto = new PostUpdateDto("제목수정", "본문수정"); + + BDDMockito.given(postRepository.findById(fakePostId)).willReturn(Optional.of(post)); + + // when + PostResponseDto updatedPost = postService.updatePost(postUpdateDto, fakePostId); + + // then + assertThat(updatedPost.title()).isEqualTo(postUpdateDto.title()); + assertThat(updatedPost.content()).isEqualTo(postUpdateDto.content()); + } +} diff --git a/src/test/java/com/programmers/domain/post/ui/PostControllerTest.java b/src/test/java/com/programmers/domain/post/ui/PostControllerTest.java new file mode 100644 index 000000000..aeba817f8 --- /dev/null +++ b/src/test/java/com/programmers/domain/post/ui/PostControllerTest.java @@ -0,0 +1,151 @@ +package com.programmers.domain.post.ui; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.programmers.domain.post.application.PostService; +import com.programmers.domain.post.ui.dto.PostCreateDto; +import com.programmers.domain.post.ui.dto.PostUpdateDto; +import com.programmers.domain.user.application.UserService; +import com.programmers.domain.user.ui.dto.UserDto; +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.MediaType; +import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; +import org.springframework.restdocs.payload.JsonFieldType; +import org.springframework.restdocs.payload.PayloadDocumentation; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; +import org.springframework.test.web.servlet.result.MockMvcResultHandlers; +import org.springframework.test.web.servlet.result.MockMvcResultMatchers; + +@AutoConfigureRestDocs +@AutoConfigureMockMvc +@SpringBootTest +class PostControllerTest { + + @Autowired + private MockMvc mockMvc; + + @Autowired + private ObjectMapper objectMapper; + + @Autowired + private UserService userService; + + @Autowired + private PostService postService; + + + @DisplayName("게시글을 생성할 수 있다.") + @Test + void createPost() throws Exception { + //given + Long userId = userService.createUser(new UserDto("유명한", 25, "농구")); + PostCreateDto postCreateDto = new PostCreateDto("제목", "본문", userId); + + //when, then + mockMvc.perform(MockMvcRequestBuilders.post("/api/posts") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(postCreateDto))) + .andExpect(MockMvcResultMatchers.status().isCreated()) + .andDo(MockMvcResultHandlers.print()) + .andDo(MockMvcRestDocumentation.document("post-save", + PayloadDocumentation.requestFields( + PayloadDocumentation.fieldWithPath("title").type(JsonFieldType.STRING).description("title"), + PayloadDocumentation.fieldWithPath("content").type(JsonFieldType.STRING).description("content"), + PayloadDocumentation.fieldWithPath("userId").type(JsonFieldType.NUMBER).description("userId") + ), + PayloadDocumentation.responseFields( + PayloadDocumentation.fieldWithPath("id").type(JsonFieldType.NUMBER).description("id") + ) + )) + .andReturn(); + } + + @DisplayName("전체 게시글을 조회할 수 있다.") + @Test + void findPostList() throws Exception { + //given + Long userId = userService.createUser(new UserDto("유명한", 25, "농구")); + + PostCreateDto postCreateDto1 = new PostCreateDto("제목1", "본문1", userId); + postService.createPost(postCreateDto1); + + PostCreateDto postCreateDto2 = new PostCreateDto("제목2", "본문2", userId); + postService.createPost(postCreateDto2); + + PostCreateDto postCreateDto3 = new PostCreateDto("제목3", "본문3", userId); + postService.createPost(postCreateDto3); + + //when, then + mockMvc.perform(MockMvcRequestBuilders.get("/api/posts") + .param("page", "0") + .param("size", "20") + .param("sort", "id,desc")) + .andExpect(MockMvcResultMatchers.status().isOk()) + .andDo(MockMvcResultHandlers.print()) + .andDo(MockMvcRestDocumentation.document("posts-find", + PayloadDocumentation.responseFields( + PayloadDocumentation.fieldWithPath("[].title").type(JsonFieldType.STRING).description("title"), + PayloadDocumentation.fieldWithPath("[].content").type(JsonFieldType.STRING).description("content"), + PayloadDocumentation.fieldWithPath("[].userId").type(JsonFieldType.NUMBER).description("userId"), + PayloadDocumentation.fieldWithPath("[].postId").type(JsonFieldType.NUMBER).description("postId") + ) + )) + .andReturn(); + } + + @DisplayName("게시글을 조회할 수 있다.") + @Test + void findPost() throws Exception { + //given + Long userId = userService.createUser(new UserDto("유명한", 25, "농구")); + PostCreateDto postCreateDto = new PostCreateDto("제목", "본문", userId); + Long postId = postService.createPost(postCreateDto); + + //when, then + mockMvc.perform(MockMvcRequestBuilders.get("/api/posts/{id}", postId)) + .andExpect(MockMvcResultMatchers.status().isOk()) + .andDo(MockMvcResultHandlers.print()) + .andDo(MockMvcRestDocumentation.document("post-find", + PayloadDocumentation.responseFields( + PayloadDocumentation.fieldWithPath("title").type(JsonFieldType.STRING).description("title"), + PayloadDocumentation.fieldWithPath("content").type(JsonFieldType.STRING).description("content"), + PayloadDocumentation.fieldWithPath("userId").type(JsonFieldType.NUMBER).description("userId"), + PayloadDocumentation.fieldWithPath("postId").type(JsonFieldType.NUMBER).description("postId") + ) + )) + .andReturn(); + } + + @DisplayName("게시글을 수정할 수 있다.") + @Test + void updatePost() throws Exception{ + //given + Long userId = userService.createUser(new UserDto("유명한", 25, "농구")); + PostCreateDto postCreateDto = new PostCreateDto("제목", "본문", userId); + Long postId = postService.createPost(postCreateDto); + + PostUpdateDto postUpdateDto = new PostUpdateDto("제목수정", "본문수정"); + postService.updatePost(postUpdateDto, postId); + + //when, then + mockMvc.perform(MockMvcRequestBuilders.patch("/api/posts/{id}", postId) + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(postUpdateDto))) + .andExpect(MockMvcResultMatchers.status().isOk()) + .andDo(MockMvcResultHandlers.print()) + .andDo(MockMvcRestDocumentation.document("post-update", + PayloadDocumentation.responseFields( + PayloadDocumentation.fieldWithPath("title").type(JsonFieldType.STRING).description("title"), + PayloadDocumentation.fieldWithPath("content").type(JsonFieldType.STRING).description("content"), + PayloadDocumentation.fieldWithPath("userId").type(JsonFieldType.NUMBER).description("userId"), + PayloadDocumentation.fieldWithPath("postId").type(JsonFieldType.NUMBER).description("postId") + ) + )) + .andReturn(); + } +} diff --git a/src/test/resources/application.yml b/src/test/resources/application.yml new file mode 100644 index 000000000..bfe5db6b6 --- /dev/null +++ b/src/test/resources/application.yml @@ -0,0 +1,9 @@ +spring: + jpa: + open-in-view: false + hibernate: + ddl-auto: create-drop + properties: + hibernate: + format_sql: true + show_sql: true