오류 코드 참조

오류 코드 참조 문서

CheonYakPlanet 백엔드 관련 문서입니다.

Error Code Reference

📋 Overview

이 문서는 CheonYakPlanet 애플리케이션에서 사용되는 모든 오류 코드를 설명, 원인, 해결 방법과 함께 제공합니다.

🔢 Error Code Format

오류 코드는 [CATEGORY][NUMBER] 패턴을 따릅니다.

  • Category: 기능 영역을 나타내는 3-4자의 접두사
  • Number: 3자리 순차 번호 (001-999)

🔐 Authentication & Authorization (AUTH)

AUTH001 - 인증이 필요한 서비스입니다

  • Description: Authentication required for this service
  • HTTP Status: 401 Unauthorized

Typical Causes

  • JWT 토큰이 Authorization 헤더에 없음
  • 인증 없이 보호된 엔드포인트 요청
  • 잘못된 Authorization 헤더 형식

Resolution

  • 유효한 JWT 토큰 포함: Authorization: Bearer {token}
  • 로그인 후 토큰 획득
  • 토큰 형식 확인

Example Response

{
    "status": "fail",
    "data": {
        "code": "AUTH001",
        "message": "인증이 필요한 서비스입니다",
        "details": "Authorization header is missing"
    }
}

AUTH002 - 권한이 없습니다

  • Description: Insufficient permissions
  • HTTP Status: 403 Forbidden

Typical Causes

  • 필요한 역할(예: ADMIN) 미보유
  • 다른 사용자 데이터 접근 시도
  • 역할 기반 접근 제어 제한

Resolution

  • 관리자에게 역할 업그레이드 요청
  • 자신의 데이터 요청 확인
  • 엔드포인트 권한 설정 확인

AUTH003 - 유효하지 않은 JWT 서명

  • Description: Invalid JWT signature
  • HTTP Status: 401 Unauthorized

Typical Causes

  • Token tampered with or corrupted
  • Wrong signing key used
  • Token from different environment

Resolution

  • Re-login to get new token
  • Check token integrity
  • Verify environment configuration

AUTH004 - 만료된 JWT 토큰

  • Description: Expired JWT token
  • HTTP Status: 401 Unauthorized

Typical Causes

  • Access token expired (60 minutes)
  • System clock skew
  • Token used after expiry

Resolution

  • Use refresh token to get new access token
  • Re-login if refresh token also expired
  • Check system time synchronization

👤 User Management (SIGN)

SIGN001 - 이미 존재하는 회원입니다

Typical Causes

Resolution

SIGN002 - 존재하지 않는 회원입니다

Typical Causes

Resolution

💬 Community (POST, COMMENT)

POST001 - 게시글을 찾을 수 없습니다

Typical Causes

Resolution

COMMENT001 - 댓글을 찾을 수 없습니다

Typical Causes

Resolution

🏠 Subscription (SUB)

SUB001 - 청약 정보를 찾을 수 없습니다

Typical Causes

Resolution

💰 Finance (FIN)

FIN001 - 금융 상품을 찾을 수 없습니다

Typical Causes

Resolution

📰 News (NEWS)

NEWS001 - 뉴스 크롤링 실패

Typical Causes

Resolution

🔧 System (SYS)

SYS001 - 시스템 오류가 발생했습니다

Typical Causes

Resolution

✅ Validation (VAL)

VAL001 - 필수 입력값이 누락되었습니다

Typical Causes

Resolution


Error Code Reference Version: 1.0

Last Updated: 2025-06-26

Total Error Codes: 50+