diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..8af972c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +/gradlew text eol=lf +*.bat text eol=crlf +*.jar binary diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..89deeb4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,38 @@ +--- +name: BUG REPORT +about: 버그 리포트 기본 구조입니다. +title: " [OS-브라우저-가로사이즈-페이지명] 안건" +labels: '' +assignees: '' + +--- + +**버그 설명** +버그에 대한 명확하고 간결한 설명해주세요. + +**재현하는 방법** +동작을 재현하는 단계: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**예상한 동작** +예상했던 일에 대한 명확하고 간결한 설명해주세요. + +**스크린샷** + 문제를 설명하는 데 도움이 되는 스크린샷을 추가하세요. 스크린샷으로 어렵다면 영상첨부해주세요. + +**데스크톱(다음 정보를 작성해 주세요):** + - OS: [예) iOS] + - Browser [예) chrome, safari] + - Version [예) 22] + +**스마트폰(다음 정보를 입력하세요):** + - Device: [예) iPhone6] + - OS: [예) iOS8.1] + - Browser [예) chrome, safari] + - Version [예) 22] + +**추가적인 내용:** +여기에 문제에 대한 다른 컨텍스트를 추가해주세요. diff --git "a/.github/ISSUE_TEMPLATE/feature-\354\203\235\354\204\261-\353\223\261\353\241\235.md" "b/.github/ISSUE_TEMPLATE/feature-\354\203\235\354\204\261-\353\223\261\353\241\235.md" new file mode 100644 index 0000000..989212d --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/feature-\354\203\235\354\204\261-\353\223\261\353\241\235.md" @@ -0,0 +1,17 @@ +--- +name: Feature 생성/등록 +about: 1 task per 1 issue +title: "[FEATURE] #0-0 Feature 상세" +labels: '' +assignees: '' + +--- + +## 🌴 작업 브랜치 + +## 💼 TASK 개요 + +## ✅ TODO 및 진행현황 + +- [ ] 투-두 1 +- [ ] 투-두 2 diff --git a/.github/ISSUE_TEMPLATE/refactor-request.md b/.github/ISSUE_TEMPLATE/refactor-request.md new file mode 100644 index 0000000..397f3b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactor-request.md @@ -0,0 +1,32 @@ +--- +name: Refactor request +about: 리팩토링 제안 템플릿입니다. +title: '' +labels: '' +assignees: '' + +--- + + + + + +## ✅ Refactor Request check list + +- [x] 이슈 제목: [REFACTOR] '리팩토링 내용 상세' +- [ ] Assignees, Label을 붙여주세요. + +## 리팩토링 개요 + +- 이런 걸 해야해 + +## TODO + +- [ ] 이거 하려면 이런 걸 해야해 +- [ ] 이것도 해야할 것 같아 diff --git a/.github/ISSUE_TEMPLATE/self-bug-report.md b/.github/ISSUE_TEMPLATE/self-bug-report.md new file mode 100644 index 0000000..ff6552f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/self-bug-report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: 버그 리포트 템플릿입니다. +title: '' +labels: '' +assignees: '' +--- + + + + + +## ✅ Bug Report check list + +- [x] 이슈 제목: [BUG] '버그 내용 상세' +- [ ] Assignees, Label을 붙여주세요. + +## BUG 개요 + +- 이런 버그가 있어 +- 그래서 이런 문제가 있어 +- 이런 식으로 재현이 돼 +- 이 파일에서 문제가 발생한 거 같아 + +## TODO + +- [ ] 이거 하려면 이런 걸 해야해 +- [ ] 이것도 해야할 것 같아 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0c5b17d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ +## ✅ PR check list + + + +- [x] PR 제목: [feat/fix/refactor...] 작업 내용 한 줄 요약 (브랜치 이름) #이슈번호 +- [ ] commit message가 적절한지 확인해주세요. +- [ ] 적절한 branch로 요청했는지 확인해주세요. +- [ ] Assignees, Label을 붙여주세요. +- [ ] 주의 사항과 관련해 꼭 확인해야 할 사람이 있다면 Reviewer로 등록해주세요. +- [ ] PR이 승인된 경우 해당 브랜치는 삭제 부탁드립니다. + +
+ +## 📝 PR 요약 + + + +- 이걸 했어 +- 저것도 했어 +- +- resolved: #1(해당 Issue Number) 무슨 이슈에 대한 작업인지 명시합니다. 해당 이슈를 이곳에 적으면 pr merge 이후 해당 이슈는 자동으로 close 됩니다. + +
+ +## 📌 변경 사항 및 주의 사항 + + + +
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..02565e7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,38 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ +/src/main/resources/application.yml diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..29ce719 --- /dev/null +++ b/build.gradle @@ -0,0 +1,35 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.2.3' + id 'io.spring.dependency-management' version '1.1.7' +} + +group = 'com.example' +version = '0.0.1-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + implementation 'org.springframework.boot:spring-boot-starter-web' + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'mysql:mysql-connector-java:8.0.33' + implementation 'org.springframework.boot:spring-boot-starter-jdbc' + implementation 'org.projectlombok:lombok:1.18.28' + annotationProcessor 'org.projectlombok:lombok:1.18.28' + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..a4b76b9 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 0000000..e18bc25 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..f5feea6 --- /dev/null +++ b/gradlew @@ -0,0 +1,252 @@ +#!/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. +# +# 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 +' "$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 + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=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" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, 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" \ + -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 0000000..9d21a21 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@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 + +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 0000000..0bcef58 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'stockApi' diff --git a/src/main/java/com/example/stockApi/StockApiApplication.java b/src/main/java/com/example/stockApi/StockApiApplication.java new file mode 100644 index 0000000..16d005e --- /dev/null +++ b/src/main/java/com/example/stockApi/StockApiApplication.java @@ -0,0 +1,11 @@ +package com.example.stockApi; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class StockApiApplication { + public static void main(String[] args) { + SpringApplication.run(StockApiApplication.class, args); + } +} diff --git a/src/main/java/com/example/stockApi/controller/stock/StockHistoryController.java b/src/main/java/com/example/stockApi/controller/stock/StockHistoryController.java new file mode 100644 index 0000000..4c730ec --- /dev/null +++ b/src/main/java/com/example/stockApi/controller/stock/StockHistoryController.java @@ -0,0 +1,66 @@ +package com.example.stockApi.controller.stock; + +import com.example.stockApi.dto.stock.StockHistoryResponse; +import com.example.stockApi.entity.StocksHistoryEntity; +import com.example.stockApi.exception.ApiException; +import com.example.stockApi.service.StockHistoryService; +import com.example.stockApi.exception.ErrorCode; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +import java.util.List; +import java.time.LocalDate; + +@RestController +@RequestMapping("/api/v1/stock/history") +public class StockHistoryController { + private final StockHistoryService stockHistoryService; + @Autowired + public StockHistoryController(StockHistoryService stockHistoryService){ + this.stockHistoryService = stockHistoryService; + } + + @GetMapping + public ResponseEntity> getStockHistory( + @RequestParam String company_code, + @RequestParam String start_date, + @RequestParam String end_date, + @RequestHeader(value = "x-api-key", required = false) String apiKey){ + + validateApiKey(apiKey); + if (start_date == null || start_date.isEmpty()) { + throw new ApiException(ErrorCode.MISSING_START_DATE); + } + if (end_date == null || end_date.isEmpty()) { + throw new ApiException(ErrorCode.MISSING_END_DATE); + } + + LocalDate start = parseDate(start_date, "start"); + LocalDate end = parseDate(end_date, "end"); + + return ResponseEntity.ok(stockHistoryService.getStockHistory(company_code, start, end)); + } + + private void validateApiKey(String apiKey){ + final String VALID_API_KEY = "c18aa07f-f005-4c2f-b6db-dff8294e6b5e"; + if(apiKey == null || apiKey.isEmpty()){ + throw new ApiException(ErrorCode.MISSING_API_KEY); + } + if (!VALID_API_KEY.equals(apiKey)) { + throw new ApiException(ErrorCode.INVALID_API_KEY); + } + } + + private LocalDate parseDate(String date, String type) { + try { + return LocalDate.parse(date); + } catch (Exception e) { + if(type.equals("start")){ + throw new ApiException(ErrorCode.INVALID_START_DATE_FORMAT); + } else { + throw new ApiException(ErrorCode.INVALID_END_DATE_FORMAT); + } + } + } +} diff --git a/src/main/java/com/example/stockApi/dto/stock/StockHistoryResponse.java b/src/main/java/com/example/stockApi/dto/stock/StockHistoryResponse.java new file mode 100644 index 0000000..d798658 --- /dev/null +++ b/src/main/java/com/example/stockApi/dto/stock/StockHistoryResponse.java @@ -0,0 +1,16 @@ +package com.example.stockApi.dto.stock; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.time.LocalDate; + +@Getter +@NoArgsConstructor +@AllArgsConstructor +public class StockHistoryResponse { + private String companyName; // 기업명 + private LocalDate tradeDate; // 거래 날짜 + private double closingPrice; // 종가 +} diff --git a/src/main/java/com/example/stockApi/entity/CompanyEntity.java b/src/main/java/com/example/stockApi/entity/CompanyEntity.java new file mode 100644 index 0000000..731f226 --- /dev/null +++ b/src/main/java/com/example/stockApi/entity/CompanyEntity.java @@ -0,0 +1,22 @@ +package com.example.stockApi.entity; + +import jakarta.persistence.*; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +@Entity +@Getter +@Setter +@EqualsAndHashCode +@NoArgsConstructor +@Table(name = "company", schema = "assignment") +public class CompanyEntity { + @Id + @Column(name = "company_code", nullable = false, length = 10) + private String companyCode; + + @Column(name = "company_name", nullable = false) + private String companyName; +} diff --git a/src/main/java/com/example/stockApi/entity/StocksHistoryEntity.java b/src/main/java/com/example/stockApi/entity/StocksHistoryEntity.java new file mode 100644 index 0000000..e9a394d --- /dev/null +++ b/src/main/java/com/example/stockApi/entity/StocksHistoryEntity.java @@ -0,0 +1,42 @@ +package com.example.stockApi.entity; + +import jakarta.persistence.*; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +import java.io.Serializable; +import java.time.LocalDate; + +@Entity +@Getter +@Setter +@EqualsAndHashCode +@NoArgsConstructor +@Table(name = "stocks_history", schema = "assignment") +@IdClass(StocksHistoryEntityPK.class) +public class StocksHistoryEntity implements Serializable { + @Id + @Column(name = "company_code", nullable = false, length = 10) + private String companyCode; + + @Id + @Column(name = "trade_date", nullable = false) + private LocalDate tradeDate; + + @Column(name = "open_price", nullable = false) + private double openPrice; + + @Column(name = "high_price", nullable = false) + private double highPrice; + + @Column(name = "low_price", nullable = false) + private double lowPrice; + + @Column(name = "close_price", nullable = false) + private double closePrice; + + @Column(name = "volume", nullable = false) + private double volume; +} diff --git a/src/main/java/com/example/stockApi/entity/StocksHistoryEntityPK.java b/src/main/java/com/example/stockApi/entity/StocksHistoryEntityPK.java new file mode 100644 index 0000000..4071a31 --- /dev/null +++ b/src/main/java/com/example/stockApi/entity/StocksHistoryEntityPK.java @@ -0,0 +1,14 @@ +package com.example.stockApi.entity; + +import lombok.EqualsAndHashCode; +import lombok.NoArgsConstructor; + +import java.io.Serializable; +import java.time.LocalDate; + +@EqualsAndHashCode +@NoArgsConstructor +public class StocksHistoryEntityPK implements Serializable { + private String companyCode; + private LocalDate tradeDate; +} diff --git a/src/main/java/com/example/stockApi/exception/ApiException.java b/src/main/java/com/example/stockApi/exception/ApiException.java new file mode 100644 index 0000000..ab58b39 --- /dev/null +++ b/src/main/java/com/example/stockApi/exception/ApiException.java @@ -0,0 +1,13 @@ +package com.example.stockApi.exception; + +import lombok.Getter; +import com.example.stockApi.exception.ErrorCode; +@Getter +public class ApiException extends RuntimeException { + private final int statusCode; + + public ApiException(ErrorCode errorCode) { + super(errorCode.getMessage()); + this.statusCode = errorCode.getStatusCode(); + } +} diff --git a/src/main/java/com/example/stockApi/exception/ErrorCode.java b/src/main/java/com/example/stockApi/exception/ErrorCode.java new file mode 100644 index 0000000..94c24ce --- /dev/null +++ b/src/main/java/com/example/stockApi/exception/ErrorCode.java @@ -0,0 +1,32 @@ +package com.example.stockApi.exception; + +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +public enum ErrorCode { + // API 관련 에러 + MISSING_API_KEY(HttpStatus.BAD_REQUEST.value(), "MISSING_API_KEY"), + INVALID_API_KEY(HttpStatus.FORBIDDEN.value(), "INVALID_API_KEY"), + + // 파라미터 관련 에러 + MISSING_COMPANY_CODE(HttpStatus.BAD_REQUEST.value(), "MISSING_COMPANY_CODE"), + MISSING_START_DATE(HttpStatus.BAD_REQUEST.value(), "MISSING_START_DATE"), + MISSING_END_DATE(HttpStatus.BAD_REQUEST.value(), "MISSING_END_DATE"), + + INVALID_START_DATE_FORMAT(HttpStatus.BAD_REQUEST.value(), "INVALID_START_DATE_FORMAT"), + INVALID_END_DATE_FORMAT(HttpStatus.BAD_REQUEST.value(), "INVALID_END_DATE_FORMAT"), + + COMPANY_NOT_FOUND(HttpStatus.NOT_FOUND.value(), "COMPANY_NOT_FOUND"), + + // 나머지 에러 + INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR.value(), "INTERNAL_SERVER_ERROR"); + + private final int statusCode; + private final String message; + + ErrorCode(int statusCode, String message) { + this.statusCode = statusCode; + this.message = message; + } +} diff --git a/src/main/java/com/example/stockApi/exception/GlobalExceptionHandler.java b/src/main/java/com/example/stockApi/exception/GlobalExceptionHandler.java new file mode 100644 index 0000000..e65211a --- /dev/null +++ b/src/main/java/com/example/stockApi/exception/GlobalExceptionHandler.java @@ -0,0 +1,32 @@ +package com.example.stockApi.exception; + +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import com.example.stockApi.exception.ErrorCode; + +import java.util.Map; + +@RestControllerAdvice +public class GlobalExceptionHandler { + // API 처리 과정 중 에러 처리 + @ExceptionHandler(ApiException.class) + public ResponseEntity> handleApiException(ApiException ex) { + return ResponseEntity.status(ex.getStatusCode()) + .body(Map.of( + "statusCode", ex.getStatusCode(), + "message", ex.getMessage() + )); + } + + // API 에러가 아닌 500 에러 처리 + @ExceptionHandler(Exception.class) + public ResponseEntity> handleUnexpectedException(Exception ex) { + return ResponseEntity.status(ErrorCode.INTERNAL_SERVER_ERROR.getStatusCode()) + .body(Map.of( + "statusCode", ErrorCode.INTERNAL_SERVER_ERROR.getStatusCode(), + "message", ErrorCode.INTERNAL_SERVER_ERROR.getMessage(), + "details", ex.getMessage() + )); + } +} \ No newline at end of file diff --git a/src/main/java/com/example/stockApi/repository/stock/CompanyRepository.java b/src/main/java/com/example/stockApi/repository/stock/CompanyRepository.java new file mode 100644 index 0000000..c04024c --- /dev/null +++ b/src/main/java/com/example/stockApi/repository/stock/CompanyRepository.java @@ -0,0 +1,12 @@ +package com.example.stockApi.repository.stock; + +import com.example.stockApi.entity.CompanyEntity; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +import java.util.Optional; + +@Repository +public interface CompanyRepository extends JpaRepository { + Optional findByCompanyCode(String companyCode); +} diff --git a/src/main/java/com/example/stockApi/repository/stock/StocksHistoryRepository.java b/src/main/java/com/example/stockApi/repository/stock/StocksHistoryRepository.java new file mode 100644 index 0000000..c9ea327 --- /dev/null +++ b/src/main/java/com/example/stockApi/repository/stock/StocksHistoryRepository.java @@ -0,0 +1,30 @@ +package com.example.stockApi.repository.stock; + +import com.example.stockApi.dto.stock.StockHistoryResponse; +import com.example.stockApi.entity.StocksHistoryEntity; +import com.example.stockApi.entity.StocksHistoryEntityPK; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Query; +import org.springframework.data.repository.query.Param; +import org.springframework.stereotype.Repository; + +import java.time.LocalDate; +import java.util.List; + +@Repository +public interface StocksHistoryRepository extends JpaRepository { + @Query(""" + SELECT new com.example.stockApi.dto.stock.StockHistoryResponse( + c.companyName, s.tradeDate, s.closePrice + ) + FROM StocksHistoryEntity s + JOIN CompanyEntity c ON s.companyCode = c.companyCode + WHERE s.companyCode = :companyCode + AND s.tradeDate BETWEEN :startDate AND :endDate + """) + List findStockHistoryWithCompanyName( + @Param("companyCode") String companyCode, + @Param("startDate") LocalDate startDate, + @Param("endDate") LocalDate endDate + ); +} diff --git a/src/main/java/com/example/stockApi/service/StockHistoryService.java b/src/main/java/com/example/stockApi/service/StockHistoryService.java new file mode 100644 index 0000000..180e1eb --- /dev/null +++ b/src/main/java/com/example/stockApi/service/StockHistoryService.java @@ -0,0 +1,38 @@ +package com.example.stockApi.service; + +import com.example.stockApi.dto.stock.StockHistoryResponse; +import com.example.stockApi.entity.StocksHistoryEntity; +import com.example.stockApi.exception.ApiException; +import com.example.stockApi.repository.stock.CompanyRepository; +import com.example.stockApi.repository.stock.StocksHistoryRepository; +import com.example.stockApi.exception.ErrorCode; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.time.LocalDate; +import java.util.List; + +@Service +public class StockHistoryService { + + private final StocksHistoryRepository stocksHistoryRepository; + private final CompanyRepository companyRepository; + + @Autowired + public StockHistoryService(StocksHistoryRepository stocksHistoryRepository, CompanyRepository companyRepository) { + this.stocksHistoryRepository = stocksHistoryRepository; + this.companyRepository = companyRepository; + } + + public List getStockHistory(String companyCode, LocalDate startDate, LocalDate endDate){ + boolean exists = companyRepository.findByCompanyCode(companyCode).isPresent(); + if(!exists){ + throw new ApiException(ErrorCode.COMPANY_NOT_FOUND); + } + + List stockHistoryEntities = stocksHistoryRepository.findStockHistoryWithCompanyName(companyCode, startDate, endDate); + + return stockHistoryEntities; + } + +} \ No newline at end of file diff --git a/src/main/resources/static/openapi.yaml b/src/main/resources/static/openapi.yaml new file mode 100644 index 0000000..2dda660 --- /dev/null +++ b/src/main/resources/static/openapi.yaml @@ -0,0 +1,189 @@ +openapi: 3.0.0 +info: + title: 🏷 Stock 주식 정보 제공 API + description: 회사별 주식 종료가 데이터를 조회하는 API + version: "1.0.0" + contact: + email: yulim38392@naver.com + license: + name: Apache 2.0 + url: "http://www.apache.org/licenses/LICENSE-2.0.html" + +servers: + - url: https://virtserver.swaggerhub.com/spring-1d3/stockapi/1.0.0 + description: SwaggerHub API Auto Mocking + - url: http://localhost:8080 + description: Local Development Server + +tags: + - name: developers + description: 주식 데이터를 조회하는 API + +paths: + /api/v1/stock/history: + get: + tags: + - developers + summary: 특정 기업의 주식 종가 조회 + operationId: getStockHistory + description: | + 특정 기업의 주식 종가 데이터를 기간별로 조회할 수 있습니다. + parameters: + - in: query + name: company_code + description: 기업의 종목 코드 + required: true + schema: + type: string + example: "ACM" + - in: query + name: start_date + description: | + 조회 시작 날짜 (형식: YYYY-MM-DD) + - 필수 값입니다. + - 올바른 형식이 아닐 경우 `INVALID_DATE_FORMAT` 오류가 발생합니다. + required: true + schema: + type: string + format: date + example: "2025-01-01" + - in: query + name: end_date + description: | + 조회 종료 날짜 (형식: YYYY-MM-DD) + - 필수 값입니다. + - 올바른 형식이 아닐 경우 `INVALID_DATE_FORMAT` 오류가 발생합니다. + required: true + schema: + type: string + format: date + example: "2025-02-01" + - in: header + name: x-api-key + description: API 키 (필수) + required: true + schema: + type: string + example: "c18aa07f-f005-4c2f-b6db-dff8294e6b5e" + responses: + "200": + description: 요청한 종목의 주식 종가 데이터 조회 성공 + content: + application/json: + schema: + type: array + items: + $ref: "#/components/schemas/StockHistory" + + "400": + description: 요청 파라미터 누락 또는 유효하지 않은 값 + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + missingCompanyCode: + summary: company_code 누락 + value: + errorCode: 400 + message: "MISSING_COMPANY_CODE" + missingStartDate: + summary: start_date 누락 + value: + errorCode: 400 + message: "MISSING_START_DATE" + missingEndDate: + summary: end_date 누락 + value: + errorCode: 400 + message: "MISSING_END_DATE" + invalidStartDateFormat: + summary: 잘못된 `start_date` 형식 + value: + errorCode: 400 + message: "INVALID_START_DATE_FORMAT" + invalidEndDateFormat: + summary: 잘못된 `end_date` 형식 + value: + errorCode: 400 + message: "INVALID_END_DATE_FORMAT" + + "403": + description: API Key 인증 실패 + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + missingApiKey: + summary: API Key 없음 + value: + errorCode: 403 + message: "MISSING_API_KEY" + invalidApiKey: + summary: API Key 인증 실패 + value: + errorCode: 403 + message: "INVALID_API_KEY" + + "404": + description: 기업 코드가 존재하지 않음 + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + companyNotFound: + summary: 기업 코드 없음 + value: + errorCode: 404 + message: "COMPANY_NOT_FOUND" + + "500": + description: 서버 내부 오류 + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + internalServerError: + summary: 서버 오류 + value: + errorCode: 500 + message: "INTERNAL_SERVER_ERROR" + +components: + schemas: + StockHistory: + type: object + required: + - companyName + - tradeDate + - closingPrice + properties: + companyName: + type: string + description: 기업명 + example: "삼성전자" + tradeDate: + type: string + format: date + description: 주식 거래 날짜 + example: "2025-01-02" + closingPrice: + type: number + format: float + description: 종가 (Close Price) + example: 71500.0 + + ErrorResponse: + type: object + properties: + errorCode: + type: integer + description: 오류 코드 (400으로 고정) + example: 400 + message: + type: string + description: 오류 메시지 코드 (프론트엔드에서 매칭하여 처리) + example: "MISSING_PARAMETER" diff --git a/src/test/java/com/example/stockApi/StockApiApplicationTests.java b/src/test/java/com/example/stockApi/StockApiApplicationTests.java new file mode 100644 index 0000000..e1f9a59 --- /dev/null +++ b/src/test/java/com/example/stockApi/StockApiApplicationTests.java @@ -0,0 +1,13 @@ +package com.example.stockApi; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class StockApiApplicationTests { + + @Test + void contextLoads() { + } + +}