sunday.ahn (안소정) BE 사전과제 제출

.dockerignore

@@ -0,0 +1,7 @@
+target
+build
+!build/libs/*.jar
+.gradle
+.git
+*.md
+*.env

Dockerfile

@@ -0,0 +1,8 @@
+FROM openjdk:17-jdk-slim
+
+# JAR 파일 복사
+COPY build/libs/*.jar app.jar
+
+ENTRYPOINT ["java", "-jar", "/app.jar"]
+
+EXPOSE 8080

MYREADME.md

@@ -0,0 +1,94 @@
+## 구현내용
+
+### API 디자인
+- 버저닝 적용(현재 v1)
+
+---
+
+### API 응답값
+  - createErrorResponse() 메서드를 사용하여 모든 에러 응답을 통일
+  - GlobalExceptionHandler에서 예외를 전역적으로 처리하여 일관성 유지
+
+    #### 성공 응답
+    | 상태 코드  | 설명                      |
+    |------------|--------------------------|
+    | `200 OK`   | 주식 정보 정상 응답       |
+
+    #### 오류 응답
+    | 상태 코드        | 설명                                     |
+    |-----------------|----------------------------------------|
+    | `400 Bad Request` | 필수 파라미터(`companyCode`, `startDate`, `endDate`)가 누락된 경우 |
+    | `400 Bad Request` | API Key가 요청에 포함되지 않은 경우 |
+    | `403 Forbidden` | 제공된 API Key가 유효하지 않은 경우 |
+    | `404 Not Found` | 존재하지 않는 API 엔드포인트 요청 시 |
+
+---
+
+### 유효성 검사
+1) API 유효성 검사
+   - 헤더(x-api-key) 또는 쿼리 파라미터(apikey) 로 제공되지 않으면 400 Bad Request
+   - API Key 값이 올바르지 않으면 403 Forbidden
+2) 필수 파라미터 검증
+    - 누락된 필수 파라미터가 있다면 각각 다른 메시지로 400 Bad Request 반환
+3) 날짜 형식 검증
+    - startDate와 endDate는 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)으로 yyyy-MM-dd 으로 변환되도록 처리
+    - 잘못된 날짜 형식이면 자동으로 400 Bad Request
+4) 존재하지않는 API 요청
+    - Spring Boot의 GlobalExceptionHandler에서 처리
+
+---
+
+### Custom Exception, log rotation
+application.properties(기본지원)과 logback-spring.xml 중 application.properties 선택<br>
+이유 : 간단하게 설정 가능하며 다른 XML 설정이 불필요하였기 때문.<br>
+but 세부적인 로그 설정이 필요하면 logback-spring.xml을 사용할 예정
+
+📌 **설정 내용**
+- **로그 파일 최대 크기**: 10MB 이상이면 자동으로 새로운 파일 생성
+- **로그 보관 기간**: 30일간 로그 유지 (이후 자동 삭제)
+- **전체 로그 저장 용량**: 1GB를 초과하면 오래된 로그부터 삭제
+- **로그 파일 저장 경로**: `logs/app.log`
+
+---
+
+### 응답형식
+사용자가 원하는 응답 포맷을 선택할 수 있도록 쿼리파라미터를 활용하여 자동 변환 지원<br>
+
+- /api/v1/stocks?format=json → JSON 응답
+- /api/v1/stocks?format=xml → XML 응답
+- 별도 지정이 없으면 기본 JSON 응답
+
+#### 💣 트러블 슈팅 💣
+**[문제]**
+- 예외 발생 시 **JSON으로만 응답이 반환됨**
+- `/api/v1/stocks?format=xml` 요청 시에도 **XML 응답이 나오지 않음**
+- `GlobalExceptionHandler`에서 정의한 **커스텀 예외 처리(`ErrorResponseDTO`)가 무시됨**
+
+**[해결 방법]**
+- `application.properties`에서 **Spring Boot의 자동 예외 처리를 비활성화**
+    ```properties
+    spring.mvc.problemdetails.enabled=false
+    ```
+
+---
+
+### 배포
+- docker, dockerhub를 사용하였고 AWS ec2에 pull받아서 배포
+- 환경변수는 .env파일로 주입<br>
+
+.env
+```
+DB_HOST=
+DB_PORT=
+DB_NAME=
+DB_USER=
+DB_PASSWORD=
+
+API_KEY=
+```
+도커 이미지 : ahnsojeong/stock-api:v3<br>
+실행 명령어 : docker run -d -p 80:8080 --name stock-api --env-file .env ahnsojeong/stock-api:v3
+
+요청 주소 : http://43.201.95.193
+
+---

build.gradle

@@ -0,0 +1,34 @@
+plugins {
+	id 'java'
+	id 'org.springframework.boot' version '3.4.2'
+	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-web'  // REST API 개발
+	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'  // JPA ORM 기능
+	implementation 'org.mariadb.jdbc:mariadb-java-client'  // MariaDB 드라이버
+	implementation 'org.projectlombok:lombok'  // Getter, Setter 자동 생성
+//	implementation 'io.github.cdimascio:dotenv-java:3.0.0' // .env 로드
+	annotationProcessor 'org.projectlombok:lombok'
+	implementation 'org.glassfish.jaxb:jaxb-runtime:4.0.3' //XML을 위한 JAXB 라이브러리 추가
+	implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml' // XML 지원 추가
+	testImplementation 'org.springframework.boot:spring-boot-starter-test'  // 테스트 지원
+}
+
+tasks.named('test') {
+	useJUnitPlatform()
+}

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