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

[AhnSunday]

기술스택

• Language : Java 17
• Framework : Spring Boot 3.4.2

구현 내용

• 특정 기업 주가 정보 조회
• API Key 인증 및 유효성 검증
• json, xml 응답 제공
• Docker, Dockerhub, AWS ec2를 이용한 배포

구현 목록

✅ API 디자인
✅ API 응답값
✅ 유효성 검사
✅ 응답 형식
✅ Custom Exception
✅ 배포
❌ Test Code
❌ API throttling

프로젝트 의존성 정리

의존성	이유
org.springframework.boot:spring-boot-starter-web	웹 애플리케이션 및 REST API 엔드포인트 제공
org.springframework.boot:spring-boot-starter-data-jpa	데이터베이스와 객체 매핑을 쉽게 하기 위해 (JPA를 활용한 ORM)
org.mariadb.jdbc:mariadb-java-client	DB와 Spring Boot 애플리케이션을 연결
org.projectlombok:lombok	Getter, Setter, 생성자 등 반복적인 코드 작성을 줄이고 가독성을 높이기 위해
org.glassfish.jaxb:jaxb-runtime:4.0.3	XML 데이터 직렬화/역직렬화를 지원
com.fasterxml.jackson.dataformat:jackson-dataformat-xml	JSON뿐만 아니라 XML 응답을 제공하기 위해
org.springframework.boot:spring-boot-starter-test	단위 테스트 및 통합 테스트를 수행

---

특별히 신경 쓴 부분

1. 환경변수관리
   • .env 파일을 사용하여 민감한 환경 변수를 안전하게 관리하고, Docker 실행 시 --env-file 옵션을 활용
2. API 응답 포맷(JSON/XML) 지원
   • format 파라미터로 원하는 응답 형식(json,xml) 선택 가능
3. 예외 처리 개선
   • NoResourceFoundException을 GlobalExceptionHandler에서 처리하도록 설정.
   • application.properties에서 spring.web.resources.add-mappings=false 설정하여 API 요청이 정적 리소스로 잘못 인식되지 않도록 설정.

아쉬운점

• 익숙하지않은 framework로 공부하는 시간이 오래걸림
• 시간부족으로 배포 자동화와 Test Code작성을 못함

---

구현 내용 상세

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 선택

이유 : 간단하게 설정 가능하며 다른 XML 설정이 불필요하였기 때문.

but 세부적인 로그 설정이 필요하면 logback-spring.xml을 사용할 예정

📌 설정 내용

• 로그 파일 최대 크기: 10MB 이상이면 자동으로 새로운 파일 생성
• 로그 보관 기간: 30일간 로그 유지 (이후 자동 삭제)
• 전체 로그 저장 용량: 1GB를 초과하면 오래된 로그부터 삭제
• 로그 파일 저장 경로: logs/app.log

---

응답형식

사용자가 원하는 응답 포맷을 선택할 수 있도록 쿼리파라미터를 활용하여 자동 변환 지원

• /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의 자동 예외 처리를 비활성화

  spring.mvc.problemdetails.enabled=false

---

배포

• docker, dockerhub를 사용하였고 AWS ec2에 pull받아서 배포
• 환경변수는 .env파일로 주입
  

.env

DB_HOST=
DB_PORT=
DB_NAME=
DB_USER=
DB_PASSWORD=

API_KEY=

도커 이미지 : ahnsojeong/stock-api:v3

실행 명령어 : docker run -d -p 80:8080 --name stock-api --env-file .env ahnsojeong/stock-api:v3

요청 주소 : http://43.201.95.193