diff --git a/.gitignore b/.gitignore index 524f096..c2065bc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,24 +1,37 @@ -# Compiled class file -*.class +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ -# Log file -*.log +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ -# BlueJ files -*.ctxt +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ -# Mobile Tools for Java (J2ME) -.mtj.tmp/ +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ -# Package Files # -*.jar -*.war -*.nar -*.ear -*.zip -*.tar.gz -*.rar - -# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml -hs_err_pid* -replay_pid* +### VS Code ### +.vscode/ diff --git a/luga/build.gradle b/luga/build.gradle new file mode 100644 index 0000000..f251431 --- /dev/null +++ b/luga/build.gradle @@ -0,0 +1,38 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.4.5' + id 'io.spring.dependency-management' version '1.1.7' +} + +group = 'com.example' +version = '0.0.1-SNAPSHOT' +description = 'umc10th' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.mysql:mysql-connector-j' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testCompileOnly 'org.projectlombok:lombok' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + testAnnotationProcessor 'org.projectlombok:lombok' + + // Swagger + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.8' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/luga/gradle/wrapper/gradle-wrapper.jar b/luga/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..61285a6 Binary files /dev/null and b/luga/gradle/wrapper/gradle-wrapper.jar differ diff --git a/luga/gradle/wrapper/gradle-wrapper.properties b/luga/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..19a6bde --- /dev/null +++ b/luga/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/luga/gradlew b/luga/gradlew new file mode 100644 index 0000000..adff685 --- /dev/null +++ b/luga/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# 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/platforms/jvm/plugins-application/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##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || 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 + + + +# 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=SC2039,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=SC2039,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" ) + + 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 optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# 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/luga/gradlew.bat b/luga/gradlew.bat new file mode 100644 index 0000000..c4bdd3a --- /dev/null +++ b/luga/gradlew.bat @@ -0,0 +1,93 @@ +@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 +@rem SPDX-License-Identifier: Apache-2.0 +@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. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +: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/luga/settings.gradle b/luga/settings.gradle new file mode 100644 index 0000000..1a0e8e6 --- /dev/null +++ b/luga/settings.gradle @@ -0,0 +1,4 @@ +plugins { + id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' +} +rootProject.name = 'umc10th' diff --git a/luga/src/main/java/com/example/umc10th/Umc10thApplication.java b/luga/src/main/java/com/example/umc10th/Umc10thApplication.java new file mode 100644 index 0000000..9983f43 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/Umc10thApplication.java @@ -0,0 +1,13 @@ +package com.example.umc10th; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Umc10thApplication { + + public static void main(String[] args) { + SpringApplication.run(Umc10thApplication.class, args); + } + +} diff --git a/luga/src/main/java/com/example/umc10th/domain/home/controller/HomeController.java b/luga/src/main/java/com/example/umc10th/domain/home/controller/HomeController.java new file mode 100644 index 0000000..f6c9ab4 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/home/controller/HomeController.java @@ -0,0 +1,46 @@ +package com.example.umc10th.domain.home.controller; + +import com.example.umc10th.domain.home.dto.HomeResDto; +import com.example.umc10th.global.apiPayload.ApiResponse; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.RequiredArgsConstructor; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +import java.util.List; + +@Tag(name = "Home", description = "홈 화면 관련 API") +@RestController +@RequestMapping("/api/home") +@RequiredArgsConstructor +public class HomeController { + + @Operation(summary = "유저 정보 조회", description = "홈 화면에서 유저의 이름 & 포인트 조회") + @GetMapping("/user-info") + public ApiResponse getUserInfo() { + HomeResDto.UserInfoResDto result = HomeResDto.UserInfoResDto.builder() + .name("testUser") + .point(1500) + .build(); + return ApiResponse.onSuccess(result); + } + + @Operation( + summary = "지역별 미션 목록 조회", + description = "특정 지역의 미션 목록 조회", + parameters = @Parameter(name = "region", description = "조회할 지역명", example = "노원구", required = true) + ) + @GetMapping + public ApiResponse getRegionMissions ( + @RequestParam String region) { + HomeResDto.RegionMissionResDto result = HomeResDto.RegionMissionResDto.builder() + .region(region) + .missions(List.of()) + .build(); + return ApiResponse.onSuccess(result); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/home/dto/HomeReqDto.java b/luga/src/main/java/com/example/umc10th/domain/home/dto/HomeReqDto.java new file mode 100644 index 0000000..7d6cf82 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/home/dto/HomeReqDto.java @@ -0,0 +1,6 @@ +package com.example.umc10th.domain.home.dto; + +public class HomeReqDto { + + public record RegionMissionReqDto(String region) {} +} diff --git a/luga/src/main/java/com/example/umc10th/domain/home/dto/HomeResDto.java b/luga/src/main/java/com/example/umc10th/domain/home/dto/HomeResDto.java new file mode 100644 index 0000000..008306d --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/home/dto/HomeResDto.java @@ -0,0 +1,30 @@ +package com.example.umc10th.domain.home.dto; + +import com.example.umc10th.domain.mission.dto.MissionResDto; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.util.List; + +public class HomeResDto { + + @Getter + @Builder + @AllArgsConstructor + @NoArgsConstructor + public static class UserInfoResDto { + private String name; + private Integer point; + } + + @Getter + @Builder + @AllArgsConstructor + @NoArgsConstructor + public static class RegionMissionResDto { + private String region; + private List missions; + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/controller/MissionController.java b/luga/src/main/java/com/example/umc10th/domain/mission/controller/MissionController.java new file mode 100644 index 0000000..ad0c4da --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/controller/MissionController.java @@ -0,0 +1,50 @@ +package com.example.umc10th.domain.mission.controller; + +import com.example.umc10th.domain.mission.dto.MissionReqDto; +import com.example.umc10th.domain.mission.dto.MissionResDto; +import com.example.umc10th.global.apiPayload.ApiResponse; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.RequiredArgsConstructor; +import org.springframework.web.bind.annotation.*; + +import java.time.LocalDateTime; +import java.util.List; + +@Tag(name = "Mission", description = "'미션 관련 API") +@RestController +@RequestMapping("/api/mission") +@RequiredArgsConstructor +public class MissionController { + + @Operation( + summary = "미션 목록 조회", + description = "상태별 미션 목록 조회", + parameters = @Parameter(name = "status", description = "미션 상태", example = "IN_PROGRESS") + ) + @GetMapping + public ApiResponse getMissions( + @RequestParam(defaultValue = "IN_PROGRESS") String status) { + MissionResDto.MissionListResDto result = MissionResDto.MissionListResDto.builder() + .missions(List.of()) + .hasNext(false) + .build(); + return ApiResponse.onSuccess(result); + } + + @Operation( + summary = "미션 성공 처리", + description = "미션 ID를 경로 변수로 받아 해당 미션 성공 처리 진행", + parameters = @Parameter(name = "missionId", description = "성공 처리할 미션 ID", example = "1") + ) + @PostMapping("/{missionId}/success") + public ApiResponse completeMission( + @PathVariable Long missionId) { + MissionResDto.MissionSuccessResDto result = MissionResDto.MissionSuccessResDto.builder() + .missionId(missionId) + .completedAt(LocalDateTime.now()) + .build(); + return ApiResponse.onSuccess(result); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/converter/MissionConverter.java b/luga/src/main/java/com/example/umc10th/domain/mission/converter/MissionConverter.java new file mode 100644 index 0000000..336f76a --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/converter/MissionConverter.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.converter; + +public class MissionConverter { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/dto/MissionReqDto.java b/luga/src/main/java/com/example/umc10th/domain/mission/dto/MissionReqDto.java new file mode 100644 index 0000000..09a971f --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/dto/MissionReqDto.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.dto; + +public class MissionReqDto { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/dto/MissionResDto.java b/luga/src/main/java/com/example/umc10th/domain/mission/dto/MissionResDto.java new file mode 100644 index 0000000..1963b6c --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/dto/MissionResDto.java @@ -0,0 +1,42 @@ +package com.example.umc10th.domain.mission.dto; + +import com.example.umc10th.domain.mission.enums.MissionStatus; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.time.LocalDateTime; +import java.util.List; + +public class MissionResDto { + + @Getter + @Builder + @AllArgsConstructor + @NoArgsConstructor + public static class MissionDto { + private Long missionId; + private String title; + private Integer point; + private MissionStatus status; + } + + @Getter + @Builder + @AllArgsConstructor + @NoArgsConstructor + public static class MissionListResDto { + private List missions; + private Boolean hasNext; + } + + @Getter + @Builder + @AllArgsConstructor + @NoArgsConstructor + public static class MissionSuccessResDto { + private Long missionId; + private LocalDateTime completedAt; + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/entity/Mission.java b/luga/src/main/java/com/example/umc10th/domain/mission/entity/Mission.java new file mode 100644 index 0000000..1dbae7c --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/entity/Mission.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.entity; + +public class Mission { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/entity/mapping/UserMission.java b/luga/src/main/java/com/example/umc10th/domain/mission/entity/mapping/UserMission.java new file mode 100644 index 0000000..6306a33 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/entity/mapping/UserMission.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.entity.mapping; + +public class UserMission { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/enums/MissionStatus.java b/luga/src/main/java/com/example/umc10th/domain/mission/enums/MissionStatus.java new file mode 100644 index 0000000..ed7ebba --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/enums/MissionStatus.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.enums; + +public enum MissionStatus { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/exception/MissionException.java b/luga/src/main/java/com/example/umc10th/domain/mission/exception/MissionException.java new file mode 100644 index 0000000..d01099f --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/exception/MissionException.java @@ -0,0 +1,7 @@ +package com.example.umc10th.domain.mission.exception; + +public class MissionException extends RuntimeException { + public MissionException(String message) { + super(message); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/exception/code/MissionErrorCode.java b/luga/src/main/java/com/example/umc10th/domain/mission/exception/code/MissionErrorCode.java new file mode 100644 index 0000000..ee79191 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/exception/code/MissionErrorCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.exception.code; + +public enum MissionErrorCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/exception/code/MissionSuccessCode.java b/luga/src/main/java/com/example/umc10th/domain/mission/exception/code/MissionSuccessCode.java new file mode 100644 index 0000000..a30e4ea --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/exception/code/MissionSuccessCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.exception.code; + +public enum MissionSuccessCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/repository/MissionRepository.java b/luga/src/main/java/com/example/umc10th/domain/mission/repository/MissionRepository.java new file mode 100644 index 0000000..3f7d19d --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/repository/MissionRepository.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.repository; + +public interface MissionRepository { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/mission/service/MissionService.java b/luga/src/main/java/com/example/umc10th/domain/mission/service/MissionService.java new file mode 100644 index 0000000..d69ce74 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/mission/service/MissionService.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.service; + +public class MissionService { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/controller/RestaurantController.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/controller/RestaurantController.java new file mode 100644 index 0000000..089c395 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/controller/RestaurantController.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.controller; + +public class RestaurantController { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/converter/RestaurantConverter.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/converter/RestaurantConverter.java new file mode 100644 index 0000000..c289a9a --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/converter/RestaurantConverter.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.converter; + +public class RestaurantConverter { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/dto/RestaurantReqDto.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/dto/RestaurantReqDto.java new file mode 100644 index 0000000..6f7cbae --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/dto/RestaurantReqDto.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.dto; + +public class RestaurantReqDto { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/dto/RestaurantResDto.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/dto/RestaurantResDto.java new file mode 100644 index 0000000..4fd7ea3 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/dto/RestaurantResDto.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.dto; + +public class RestaurantResDto { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/entity/Region.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/entity/Region.java new file mode 100644 index 0000000..fbb978d --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/entity/Region.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.entity; + +public class Region { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/entity/Restaurant.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/entity/Restaurant.java new file mode 100644 index 0000000..d3d68d6 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/entity/Restaurant.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.mission.entity; + +public class Restaurant { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/RestaurantException.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/RestaurantException.java new file mode 100644 index 0000000..ecabf3d --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/RestaurantException.java @@ -0,0 +1,7 @@ +package com.example.umc10th.domain.restaurant.exception; + +public class RestaurantException extends RuntimeException { + public RestaurantException(String message) { + super(message); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/code/RestaurantErrorCode.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/code/RestaurantErrorCode.java new file mode 100644 index 0000000..a403135 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/code/RestaurantErrorCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.exception.code; + +public enum RestaurantErrorCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/code/RestaurantSuccessCode.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/code/RestaurantSuccessCode.java new file mode 100644 index 0000000..2af2d31 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/exception/code/RestaurantSuccessCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.exception.code; + +public enum RestaurantSuccessCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/repository/RestaurantRepository.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/repository/RestaurantRepository.java new file mode 100644 index 0000000..71798d9 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/repository/RestaurantRepository.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.repository; + +public interface RestaurantRepository { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/restaurant/service/RestaurantService.java b/luga/src/main/java/com/example/umc10th/domain/restaurant/service/RestaurantService.java new file mode 100644 index 0000000..bf8e545 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/restaurant/service/RestaurantService.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.restaurant.service; + +public class RestaurantService { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/controller/ReviewController.java b/luga/src/main/java/com/example/umc10th/domain/review/controller/ReviewController.java new file mode 100644 index 0000000..5c693a7 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/controller/ReviewController.java @@ -0,0 +1,36 @@ +package com.example.umc10th.domain.review.controller; + +import com.example.umc10th.domain.review.dto.ReviewReqDto; +import com.example.umc10th.domain.review.dto.ReviewResDto; +import com.example.umc10th.global.apiPayload.ApiResponse; +import com.example.umc10th.global.apiPayload.code.status.SuccessStatus; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.RequiredArgsConstructor; +import org.springframework.web.bind.annotation.*; + +import java.time.LocalDateTime; + +@Tag(name = "Review", description = "리뷰 관련 API") +@RestController +@RequestMapping("/api/review") +@RequiredArgsConstructor +public class ReviewController { + + @Operation( + summary = "리뷰 작성", + description = "식당 ID를 경로 변수로 받아 해당 식당에 리뷰 작성", + parameters = @Parameter(name = "restaurantId", description = "리뷰를 작성할 식당의 Id", example = "1") + ) + @PostMapping("/{restaurantId}/reviews") + public ApiResponse createReview( + @PathVariable Long restaurantId, + @RequestBody ReviewReqDto.CreateReviewReqDto request) { + ReviewResDto.CreateReviewResDto result = ReviewResDto.CreateReviewResDto.builder() + .reviewId(1L) + .createdAt(LocalDateTime.now()) + .build(); + return ApiResponse.onSuccess(SuccessStatus.CREATED, result); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/converter/ReviewConverter.java b/luga/src/main/java/com/example/umc10th/domain/review/converter/ReviewConverter.java new file mode 100644 index 0000000..c2fd181 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/converter/ReviewConverter.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.review.converter; + +public class ReviewConverter { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/dto/ReviewReqDto.java b/luga/src/main/java/com/example/umc10th/domain/review/dto/ReviewReqDto.java new file mode 100644 index 0000000..7c8e319 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/dto/ReviewReqDto.java @@ -0,0 +1,9 @@ +package com.example.umc10th.domain.review.dto; + +public class ReviewReqDto { + + public record CreateReviewReqDto( + String content, + Integer rating + ) {} +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/dto/ReviewResDto.java b/luga/src/main/java/com/example/umc10th/domain/review/dto/ReviewResDto.java new file mode 100644 index 0000000..3fbe7d1 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/dto/ReviewResDto.java @@ -0,0 +1,20 @@ +package com.example.umc10th.domain.review.dto; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.time.LocalDateTime; + +public class ReviewResDto { + + @Getter + @Builder + @AllArgsConstructor + @NoArgsConstructor + public static class CreateReviewResDto { + private Long reviewId; + private LocalDateTime createdAt; + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/entity/Review.java b/luga/src/main/java/com/example/umc10th/domain/review/entity/Review.java new file mode 100644 index 0000000..5542f94 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/entity/Review.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.review.entity; + +public class Review { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/exception/ReviewException.java b/luga/src/main/java/com/example/umc10th/domain/review/exception/ReviewException.java new file mode 100644 index 0000000..1664f68 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/exception/ReviewException.java @@ -0,0 +1,7 @@ +package com.example.umc10th.domain.review.exception; + +public class ReviewException extends RuntimeException { + public ReviewException(String message) { + super(message); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/exception/code/ReviewErrorCode.java b/luga/src/main/java/com/example/umc10th/domain/review/exception/code/ReviewErrorCode.java new file mode 100644 index 0000000..0d1fcb3 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/exception/code/ReviewErrorCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.review.exception.code; + +public enum ReviewErrorCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/exception/code/ReviewSuccessCode.java b/luga/src/main/java/com/example/umc10th/domain/review/exception/code/ReviewSuccessCode.java new file mode 100644 index 0000000..fb2f221 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/exception/code/ReviewSuccessCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.review.exception.code; + +public enum ReviewSuccessCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/repository/ReviewRepository.java b/luga/src/main/java/com/example/umc10th/domain/review/repository/ReviewRepository.java new file mode 100644 index 0000000..589caf9 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/repository/ReviewRepository.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.review.repository; + +public interface ReviewRepository { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/review/service/ReviewService.java b/luga/src/main/java/com/example/umc10th/domain/review/service/ReviewService.java new file mode 100644 index 0000000..c60e350 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/review/service/ReviewService.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.review.service; + +public class ReviewService { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/controller/UserController.java b/luga/src/main/java/com/example/umc10th/domain/user/controller/UserController.java new file mode 100644 index 0000000..00d65d4 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/controller/UserController.java @@ -0,0 +1,29 @@ +package com.example.umc10th.domain.user.controller; + +import com.example.umc10th.domain.user.dto.UserReqDto; +import com.example.umc10th.domain.user.dto.UserResDto; +import com.example.umc10th.global.apiPayload.ApiResponse; +import com.example.umc10th.global.apiPayload.code.status.SuccessStatus; +import lombok.RequiredArgsConstructor; +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.RestController; + +import java.time.LocalDateTime; + +@RestController +@RequestMapping("/api") +@RequiredArgsConstructor +public class UserController { + + @PostMapping("/signup") + public ApiResponse signup( + @RequestBody UserReqDto.SignupReqDto request) { + UserResDto.SignupResDto result = UserResDto.SignupResDto.builder() + .userId(1L) + .createdAt(LocalDateTime.now()) + .build(); + return ApiResponse.onSuccess(SuccessStatus.CREATED, result); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/converter/UserConverter.java b/luga/src/main/java/com/example/umc10th/domain/user/converter/UserConverter.java new file mode 100644 index 0000000..d278c28 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/converter/UserConverter.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.converter; + +public class UserConverter { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/dto/UserReqDto.java b/luga/src/main/java/com/example/umc10th/domain/user/dto/UserReqDto.java new file mode 100644 index 0000000..7f6bf40 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/dto/UserReqDto.java @@ -0,0 +1,15 @@ +package com.example.umc10th.domain.user.dto; + +import lombok.Getter; + +public class UserReqDto { + + @Getter + public static class SignupReqDto { + private String name; + private String email; + private String password; + private String phone; + private String address; + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/dto/UserResDto.java b/luga/src/main/java/com/example/umc10th/domain/user/dto/UserResDto.java new file mode 100644 index 0000000..5687454 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/dto/UserResDto.java @@ -0,0 +1,20 @@ +package com.example.umc10th.domain.user.dto; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.time.LocalDateTime; + +public class UserResDto { + + @Getter + @Builder + @AllArgsConstructor + @NoArgsConstructor + public static class SignupResDto { + private Long userId; + private LocalDateTime createdAt; + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/entity/Agreement.java b/luga/src/main/java/com/example/umc10th/domain/user/entity/Agreement.java new file mode 100644 index 0000000..187bb80 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/entity/Agreement.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.entity; + +public class Agreement { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/entity/FoodType.java b/luga/src/main/java/com/example/umc10th/domain/user/entity/FoodType.java new file mode 100644 index 0000000..adeef20 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/entity/FoodType.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.entity; + +public class FoodType { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/entity/User.java b/luga/src/main/java/com/example/umc10th/domain/user/entity/User.java new file mode 100644 index 0000000..d1949d6 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/entity/User.java @@ -0,0 +1,25 @@ +package com.example.umc10th.domain.user.entity; + +import com.example.umc10th.domain.user.enums.Gender; +import jakarta.persistence.*; +import lombok.*; + +@Entity +@Table(name = "users") +@Getter +@Builder +@NoArgsConstructor(access = AccessLevel.PROTECTED) +@AllArgsConstructor +public class User { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + private String name; + + @Enumerated(EnumType.STRING) + private Gender gender; + + +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/entity/mapping/FoodPreference.java b/luga/src/main/java/com/example/umc10th/domain/user/entity/mapping/FoodPreference.java new file mode 100644 index 0000000..3c71060 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/entity/mapping/FoodPreference.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.entity.mapping; + +public class FoodPreference { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/enums/Gender.java b/luga/src/main/java/com/example/umc10th/domain/user/enums/Gender.java new file mode 100644 index 0000000..a9d4c21 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/enums/Gender.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.enums; + +public enum Gender { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/enums/SocialLogin.java b/luga/src/main/java/com/example/umc10th/domain/user/enums/SocialLogin.java new file mode 100644 index 0000000..71315bd --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/enums/SocialLogin.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.enums; + +public enum SocialLogin { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/exception/UserException.java b/luga/src/main/java/com/example/umc10th/domain/user/exception/UserException.java new file mode 100644 index 0000000..9728841 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/exception/UserException.java @@ -0,0 +1,7 @@ +package com.example.umc10th.domain.user.exception; + +public class UserException extends RuntimeException { + public UserException(String message) { + super(message); + } +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/exception/code/UserErrorCode.java b/luga/src/main/java/com/example/umc10th/domain/user/exception/code/UserErrorCode.java new file mode 100644 index 0000000..e3cf81d --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/exception/code/UserErrorCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.exception.code; + +public enum UserErrorCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/exception/code/UserSuccessCode.java b/luga/src/main/java/com/example/umc10th/domain/user/exception/code/UserSuccessCode.java new file mode 100644 index 0000000..f6210e6 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/exception/code/UserSuccessCode.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.exception.code; + +public enum UserSuccessCode { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/repository/UserRepository.java b/luga/src/main/java/com/example/umc10th/domain/user/repository/UserRepository.java new file mode 100644 index 0000000..c9afbec --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/repository/UserRepository.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.repository; + +public interface UserRepository { +} diff --git a/luga/src/main/java/com/example/umc10th/domain/user/service/UserService.java b/luga/src/main/java/com/example/umc10th/domain/user/service/UserService.java new file mode 100644 index 0000000..db584a9 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/domain/user/service/UserService.java @@ -0,0 +1,4 @@ +package com.example.umc10th.domain.user.service; + +public class UserService { +} diff --git a/luga/src/main/java/com/example/umc10th/global/apiPayload/ApiResponse.java b/luga/src/main/java/com/example/umc10th/global/apiPayload/ApiResponse.java new file mode 100644 index 0000000..eefb2ea --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/apiPayload/ApiResponse.java @@ -0,0 +1,50 @@ +package com.example.umc10th.global.apiPayload; + +import com.example.umc10th.global.apiPayload.code.BaseErrorCode; +import com.example.umc10th.global.apiPayload.code.BaseSuccessCode; +import com.example.umc10th.global.apiPayload.code.status.SuccessStatus; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import lombok.Getter; + +@Getter +@JsonPropertyOrder({"isSuccess", "code", "message", "result"}) +public class ApiResponse { + + @JsonProperty("isSuccess") + private final Boolean isSuccess; + private final String code; + private final String message; + private final T result; + + private ApiResponse(Boolean isSuccess, String code, String message, T result) { + this.isSuccess = isSuccess; + this.code = code; + this.message = message; + this.result = result; + } + + // 성공 with result + public static ApiResponse onSuccess(T result) { + return new ApiResponse<>(true, + SuccessStatus.OK.getCode(), + SuccessStatus.OK.getMessage(), + result); + } + + // 성공, successCode 지정 + public static ApiResponse onSuccess(BaseSuccessCode code, T result) { + return new ApiResponse<>(true, + code.getCode(), + code.getMessage(), + result); + } + + // 실패 + public static ApiResponse onFailure(BaseErrorCode code, T result ) { + return new ApiResponse<>(false, + code.getCode(), + code.getMessage(), + result); + } +} diff --git a/luga/src/main/java/com/example/umc10th/global/apiPayload/code/BaseErrorCode.java b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/BaseErrorCode.java new file mode 100644 index 0000000..137c8ac --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/BaseErrorCode.java @@ -0,0 +1,9 @@ +package com.example.umc10th.global.apiPayload.code; + +import org.springframework.http.HttpStatus; + +public interface BaseErrorCode { + HttpStatus getStatus(); + String getCode(); + String getMessage(); +} diff --git a/luga/src/main/java/com/example/umc10th/global/apiPayload/code/BaseSuccessCode.java b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/BaseSuccessCode.java new file mode 100644 index 0000000..038eb92 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/BaseSuccessCode.java @@ -0,0 +1,9 @@ +package com.example.umc10th.global.apiPayload.code; + +import org.springframework.http.HttpStatus; + +public interface BaseSuccessCode { + HttpStatus getStatus(); + String getCode(); + String getMessage(); +} diff --git a/luga/src/main/java/com/example/umc10th/global/apiPayload/code/status/ErrorStatus.java b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/status/ErrorStatus.java new file mode 100644 index 0000000..dddc71d --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/status/ErrorStatus.java @@ -0,0 +1,36 @@ +package com.example.umc10th.global.apiPayload.code.status; + +import com.example.umc10th.global.apiPayload.code.BaseErrorCode; +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor +public enum ErrorStatus implements BaseErrorCode { + + // 공통 + INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "COMMON500", "서버 에러 발생"), + BAD_REQUEST(HttpStatus.BAD_REQUEST, "COMMON400", "잘못된 요청"), + UNAUTHORIZED(HttpStatus.UNAUTHORIZED, "COMMON401", "인증 필요"), + FORBIDDEN(HttpStatus.FORBIDDEN, "COMMON403", "접근 권한 없음"), + NOT_FOUND(HttpStatus.NOT_FOUND, "COMMON404", "요청한 리소스를 찾을 수 없음"), + + // Member + MEMBER_NOT_FOUND(HttpStatus.NOT_FOUND, "MEMBER4001", "사용자를 찾을 수 없음"), + MEMBER_ALREADY_EXISTS(HttpStatus.BAD_REQUEST, "MEMBER4002", "이미 존재하는 회원임"), + + // Mission + MISSION_NOT_FOUND(HttpStatus.NOT_FOUND, "MISSION4001", "미션을 찾을 수 없음"), + MISSION_ALREADY_COMPLETED(HttpStatus.BAD_REQUEST, "MISSION4002", "이미 완료된 미션"), + + // Review + REVIEW_NOT_FOUND(HttpStatus.NOT_FOUND, "REVIEW4001", "리뷰를 찾을 수 없음"), + + // Home + REGION_NOT_FOUND(HttpStatus.NOT_FOUND, "HOME4001", "해당 지역을 찾을 수 없음"); + + private final HttpStatus status; + private final String code; + private final String message; +} diff --git a/luga/src/main/java/com/example/umc10th/global/apiPayload/code/status/SuccessStatus.java b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/status/SuccessStatus.java new file mode 100644 index 0000000..7703c9a --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/apiPayload/code/status/SuccessStatus.java @@ -0,0 +1,18 @@ +package com.example.umc10th.global.apiPayload.code.status; + +import com.example.umc10th.global.apiPayload.code.BaseSuccessCode; +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor +public enum SuccessStatus implements BaseSuccessCode { + + OK(HttpStatus.OK, "COMMON200", "요청 성공"), + CREATED(HttpStatus.CREATED, "COMMON201", "생성 성공"); + + private final HttpStatus status; + private final String code; + private final String message; +} diff --git a/luga/src/main/java/com/example/umc10th/global/apiPayload/exception/GeneralException.java b/luga/src/main/java/com/example/umc10th/global/apiPayload/exception/GeneralException.java new file mode 100644 index 0000000..5cd7892 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/apiPayload/exception/GeneralException.java @@ -0,0 +1,14 @@ +package com.example.umc10th.global.apiPayload.exception; + +import com.example.umc10th.global.apiPayload.code.BaseErrorCode; +import lombok.Getter; + +@Getter +public class GeneralException extends RuntimeException { + private final BaseErrorCode errorCode; + + public GeneralException(BaseErrorCode errorCode){ + super(errorCode.getMessage()); + this.errorCode = errorCode; + } +} diff --git a/luga/src/main/java/com/example/umc10th/global/config/SwaggerConfig.java b/luga/src/main/java/com/example/umc10th/global/config/SwaggerConfig.java new file mode 100644 index 0000000..888cad0 --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/config/SwaggerConfig.java @@ -0,0 +1,36 @@ +package com.example.umc10th.global.config; + +import io.swagger.v3.oas.models.Components; +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.info.Info; +import io.swagger.v3.oas.models.security.SecurityRequirement; +import io.swagger.v3.oas.models.security.SecurityScheme; +import io.swagger.v3.oas.models.servers.Server; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class SwaggerConfig { + + @Bean + public OpenAPI swagger() { + Info info = new Info().title("UMC10th").description("4주차 미션 Swagger").version("0.0.1"); + + // JWT 토큰 헤더 방식 + String securityScheme = "JWT TOKEN"; + SecurityRequirement securityRequirement = new SecurityRequirement().addList(securityScheme); + + Components components = new Components() + .addSecuritySchemes(securityScheme, new SecurityScheme() + .name(securityScheme) + .type(SecurityScheme.Type.HTTP) + .scheme("Bearer") + .bearerFormat("JWT")); + + return new OpenAPI() + .info(info) + .addServersItem(new Server().url("/")) + .addSecurityItem(securityRequirement) + .components(components); + } +} diff --git a/luga/src/main/java/com/example/umc10th/global/handler/GeneralExceptionAdvice.java b/luga/src/main/java/com/example/umc10th/global/handler/GeneralExceptionAdvice.java new file mode 100644 index 0000000..8e5cd1b --- /dev/null +++ b/luga/src/main/java/com/example/umc10th/global/handler/GeneralExceptionAdvice.java @@ -0,0 +1,63 @@ +package com.example.umc10th.global.handler; + +import com.example.umc10th.global.apiPayload.ApiResponse; +import com.example.umc10th.global.apiPayload.code.BaseErrorCode; +import com.example.umc10th.global.apiPayload.code.status.ErrorStatus; +import com.example.umc10th.global.apiPayload.exception.GeneralException; +import org.springframework.http.ResponseEntity; +import org.springframework.web.HttpRequestMethodNotSupportedException; +import org.springframework.web.bind.MissingServletRequestParameterException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.servlet.NoHandlerFoundException; + +@RestControllerAdvice +public class GeneralExceptionAdvice { + + // 커스텀 예외 처리 + @ExceptionHandler(GeneralException.class) + public ResponseEntity> handleGeneralException(GeneralException e) { + BaseErrorCode errorCode = e.getErrorCode(); + return ResponseEntity + .status(errorCode.getStatus()) + .body(ApiResponse.onFailure(errorCode, null)); + } + + // 존재하지 않는 URL + @ExceptionHandler(NoHandlerFoundException.class) + public ResponseEntity> handleNoHandlerFound(NoHandlerFoundException e) { + BaseErrorCode code = ErrorStatus.NOT_FOUND; + return ResponseEntity + .status(code.getStatus()) + .body(ApiResponse.onFailure(code, null)); + } + + // 지원하지 않는 HTTP 메서드 + @ExceptionHandler(HttpRequestMethodNotSupportedException.class) + public ResponseEntity> handleMethodNotSupported( + HttpRequestMethodNotSupportedException e) { + BaseErrorCode code = ErrorStatus.BAD_REQUEST; + return ResponseEntity + .status(code.getStatus()) + .body(ApiResponse.onFailure(code, null)); + } + + // 쿼리 파라미터 누락 + @ExceptionHandler(MissingServletRequestParameterException.class) + public ResponseEntity> handleMissingParam( + MissingServletRequestParameterException e) { + BaseErrorCode code = ErrorStatus.BAD_REQUEST; + return ResponseEntity + .status(code.getStatus()) + .body(ApiResponse.onFailure(code, e.getMessage())); + } + + // 그 외 모든 예외 + @ExceptionHandler(Exception.class) + public ResponseEntity> handleException(Exception e) { + BaseErrorCode code = ErrorStatus.INTERNAL_SERVER_ERROR; + return ResponseEntity + .status(code.getStatus()) + .body(ApiResponse.onFailure(code, e.getMessage())); + } +} diff --git a/luga/src/main/resources/application.yml b/luga/src/main/resources/application.yml new file mode 100644 index 0000000..1497201 --- /dev/null +++ b/luga/src/main/resources/application.yml @@ -0,0 +1,19 @@ +spring: + application: + name: "umc10th" + + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver # MySQL JDBC 드라이버 클래스 이름 + url: ${DB_URL} # jdbc:mysql://localhost:3306/{데이터베이스명} + username: ${DB_USER} # MySQL 유저 이름 + password: ${DB_PW} # MySQL 비밀번호 + + jpa: + database: mysql # 사용할 데이터베이스 유형 지정 (MySQL) + database-platform: org.hibernate.dialect.MySQLDialect # Hibernate에서 사용할 MySQL 방언(dialect) 설정 + show-sql: true # 실행된 SQL 쿼리를 콘솔에 출력할지 여부 설정 + hibernate: + ddl-auto: update # 애플리케이션 실행 시 데이터베이스 스키마의 상태를 설정 + properties: + hibernate: + format_sql: true # 출력되는 SQL 쿼리를 보기 좋게 포맷팅 \ No newline at end of file diff --git a/luga/src/test/java/com/example/umc10th/Umc10thApplicationTests.java b/luga/src/test/java/com/example/umc10th/Umc10thApplicationTests.java new file mode 100644 index 0000000..b43a96f --- /dev/null +++ b/luga/src/test/java/com/example/umc10th/Umc10thApplicationTests.java @@ -0,0 +1,13 @@ +package com.example.umc10th; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class Umc10thApplicationTests { + + @Test + void contextLoads() { + } + +}