SelfCheck_AI 6. 26.01.22

26.01.22 Readme.md

📌 SelfCheck AI Backend

SelfCheck AI는
자기소개서를 단순히 고쳐주는 AI가 아니라,
“왜 잘 썼는지 / 왜 부족한지”를 구조적으로 검증하는 AI 서비스를 목표로 합니다.

본 레포지토리는 해당 서비스의 백엔드 서버입니다.

🛠 Tech Stack

• Java 17 (LTS)
• Spring Boot 3.2.12
• Gradle
• Spring Web
• Spring Validation
• Lombok

⚠️ 현재 단계에서는 DB / AI 연동은 포함되지 않았습니다.
(백엔드 구조와 안정성부터 먼저 설계)

📁 Project Structure (초기)

com.selfcheck.ai
 ├─ common
 │   ├─ controller
 │   │   └─ HealthController
 │   ├─ response
 │   │   ├─ ApiResponse
 │   │   └─ ApiError
 │   └─ exception
 │       ├─ ErrorCode
 │       ├─ BusinessException
 │       └─ GlobalExceptionHandler
 │
 ├─ user        (예정)
 ├─ resume      (예정)
 └─ ai          (예정)

✅ Implemented Features (Phase 1)

1. Health Check API

• 서버 기동 여부 확인용 엔드포인트
• 공통 응답 포맷(ApiResponse) 적용

GET /health

{
  "success": true,
  "data": "OK",
  "error": null
}

2. Unified API Response Structure

모든 API 응답은 아래 구조를 따릅니다.

{
  "success": true | false,
  "data": { ... },
  "error": {
    "code": "ERROR_CODE",
    "message": "에러 메시지"
  }
}

3. Global Exception Handling

• ErrorCode Enum 기반 에러 분류
• BusinessException 중심의 비즈니스 예외 처리
• Validation 오류 및 예상치 못한 Runtime 예외 통합 처리

AI 연동을 고려하여 AI 전용 에러 코드를 사전에 정의했습니다.

🎯 Why this structure?

이 프로젝트는 AI 모델 자체보다
AI를 서비스로 안정적으로 운영하기 위한 백엔드 구조에 초점을 둡니다.

• 실패를 고려한 설계
• 비동기 처리 확장 가능 구조
• 에러 코드 기반 통신 계약

🚀 Next Steps

• Request / Response DTO + Validation 적용
• User / Resume 도메인 설계
• Oracle + MyBatis 연동
• 비동기 AI 처리 흐름 구현
• LLM(Editor / Evaluator) 연동