BE-Repository

데이터 수집 및 AI 분석 시스템

Spring Boot 3.5.7 기반의 백엔드 시스템으로, 외부 API에서 데이터를 수집하고 OpenAI를 활용한 콘텐츠 분석 기능을 제공합니다.

🚀 주요 기능

• 데이터 수집: API 연동 및 실시간 데이터 크롤링
• AI 분석 (예정): OpenAI GPT 모델을 활용한 콘텐츠 요약 및 분석
• 사용자 관리 (예정): 인증 및 권한 관리
• 게시판 (예정): 커뮤니티 기능

🛠️ 기술 스택

Category	Technologies
Language	Java 21 (LTS)
Framework	Spring Boot 3.5.7, Spring Framework 6.x
Database	PostgreSQL 16
AI	Spring AI 1.0.0-M4 (OpenAI Integration)
Build Tool	Gradle 8.14.3
Infrastructure	Docker, Docker Compose

주요 의존성

• Spring Web (RESTful API)
• Spring Data JPA
• Spring AI (OpenAI)
• Spring Actuator (Monitoring)
• PostgreSQL Driver
• Lombok

📦 빠른 시작

사전 요구사항

• Java 21 이상
• Docker & Docker Compose
• Git

설치 및 실행

1. 저장소 클론

git clone https://github.com/cryschan/BE-Repository.git
cd BE-Repository

2. 환경 변수 설정

cp .env.example .env

.env 파일을 열어서 다음 값들을 설정하세요:

OPENAI_API_KEY=your-openai-api-key-here
DB_HOST=localhost  # 로컬 실행 시

3-A. 로컬 개발 환경 (PostgreSQL만 Docker 사용)

# PostgreSQL 시작
docker-compose up -d postgres

# 애플리케이션 실행
./gradlew bootRun

3-B. Docker 전체 실행 (프로덕션)

# .env 파일에서 DB_HOST=postgres로 설정 후
docker-compose up -d

# 로그 확인
docker-compose logs -f app

# 종료
docker-compose down

4. 접속 확인

# Health Check
curl http://localhost:8080/actuator/health

# 데이터 수집 API 테스트
curl http://localhost:8080/api/keyword/fashion

📡 API 엔드포인트

데이터 수집 API

키워드 기반 콘텐츠 조회

외부 API에서 인기 콘텐츠를 가져옵니다.

GET /api/keyword/fashion

curl 테스트:

curl http://localhost:8080/api/keyword/fashion

응답 예시:

[
  {
    "keywordId": 1,
    "landingUrl": "https://example.com/...",
    "thumbnailUrl": "https://image.example.com/...",
    "title": "콘텐츠 제목 1",
    "viewCount": 15234,
    "score": 95.5,
    "startDate": "2024-11-15T10:00:00"
  },
  {
    "keywordId": 2,
    "landingUrl": "https://example.com/...",
    "thumbnailUrl": "https://image.example.com/...",
    "title": "콘텐츠 제목 2",
    "viewCount": 12890,
    "score": 92.3,
    "startDate": "2024-11-14T14:30:00"
  }
]

응답 필드:

• keywordId: 키워드 고유 ID
• landingUrl: 콘텐츠 URL
• thumbnailUrl: 썸네일 이미지 URL
• title: 콘텐츠 제목
• viewCount: 조회수
• score: 인기 점수
• startDate: 게시 시작일

📁 프로젝트 구조

BE-Repository/
├── src/main/java/io/github/cryschan/berepository/
│   ├── domain/
│   │   ├── ai/         🚧 구조만 생성
│   │   ├── board/      🚧 구조만 생성
│   │   └── user/       🚧 구조만 생성
│   └── _global/
│       ├── client/     ✅ RestClient 설정
│       ├── config/
│       ├── exception/
│       └── common/
├── docs/
│   └── PROJECT_STRUCTURE.md    📚 상세 문서
├── Dockerfile                  🐳 Multi-stage build
├── docker-compose.yml          🐳 PostgreSQL + App
└── .env.example               🔐 환경 변수 템플릿

상세 문서: docs/PROJECT_STRUCTURE.md

🔒 보안

• .env 파일은 Git에서 제외됩니다 (.gitignore 설정됨)
• OpenAI API 키는 반드시 환경 변수로 관리하세요
• Docker 이미지는 Non-root 사용자로 실행됩니다

🧪 테스트 코드 실행

# 전체 테스트 실행
./gradlew test

# 빌드 (테스트 포함)
./gradlew clean build

📝 개발 현황

✅ 완료

• 프로젝트 초기 설정
• Docker 환경 구성 (Multi-stage build)
• 데이터 수집 기능 구현

🚧 진행 중

• AI 도메인 구현
• Board 도메인 구현
• User 도메인 구현

⏳ 예정

• Global Exception Handler
• API 표준 응답 DTO
• Spring Security 인증
• 테스트 코드 작성
• API 문서화 (Swagger/Spring REST Docs)

---

마지막 업데이트: 2025-11-18