본문으로 건너뛰기
버전: 개발 버전 (최신)

Mobile 관련 오류 코드

Mobile 도메인 또는 관련 API(예: /mobile/settings, /mobile/app-info)에서 발생할 수 있는 오류 코드입니다.

오류 응답 형식​

{
  "code": 8001,
  "message": "INVALID_INPUT_DATA",
  "detail": "필수 파라미터가 누락되었습니다",
  "metadata": {
    "missingFields": ["platform", "appVersion"]
  }
}
필드타입설명
codenumber애플리케이션 오류 코드
messagestring개발자용 오류 코드 이름 (대문자 및 언더스코어)
detailstring사용자에게 표시할 수 있는 친화적인 오류 메시지
errorsarray필드별 유효성 검증 오류가 있는 경우 추가 정보 제공 (선택 사항)
metadataobject오류 관련 추가 메타데이터 (선택 사항)
노트

errors와 metadata 필드는 선택 사항이며, 오류 상황에 따라 포함되지 않을 수 있습니다.

오류 코드 체계​

Mobile 관련 오류는 주로 8000번대 코드를 사용합니다.

범위용도
8000서버 및 일반 Mobile 오류
8001-8009입력 검증 관련 오류
8010-8019앱 설정 관련 오류
8020-8099향후 확장을 위한 예약 범위

서버 및 일반 오류 (8000)​

HTTP 상태 코드코드메시지설명
5008000SERVER_ERROR서버 내부 오류가 발생했습니다

입력 검증 관련 오류 (8001-8009)​

모바일 앱 정보 및 플랫폼 관련 입력 데이터 검증 오류입니다.

HTTP 상태 코드코드메시지설명
4008001INVALID_INPUT_DATA필수 파라미터가 누락되었습니다
4008002INVALID_PLATFORM지원하지 않는 플랫폼입니다
4008003INVALID_APP_VERSION앱 버전이 유효하지 않습니다
4008004UNSUPPORTED_OS_VERSION지원하지 않는 OS 버전입니다

앱 설정 관련 오류 (8010-8019)​

모바일 앱 설정 조회 및 관리 관련 오류입니다.

HTTP 상태 코드코드메시지설명
4048010APP_SETTINGS_NOT_FOUND앱 설정을 찾을 수 없습니다

오류 처리 가이드​

플랫폼 및 버전 검증 오류 처리​

  • 지원하지 않는 플랫폼(8002): 사용자에게 지원되는 플랫폼 목록을 제공하고, 앱 업데이트를 안내합니다.
  • 유효하지 않은 앱 버전(8003): 사용자에게 최신 버전으로 업데이트하도록 안내합니다.
  • 지원하지 않는 OS 버전(8004): 사용자에게 최소 요구 OS 버전을 안내하고, OS 업데이트를 권장합니다.

입력 데이터 검증 오류 처리​

INVALID_INPUT_DATA (8001) 오류 발생 시:

{
  "code": 8001,
  "message": "INVALID_INPUT_DATA",
  "detail": "필수 파라미터가 누락되었습니다",
  "metadata": {
    "missingFields": ["platform", "appVersion"],
    "providedFields": ["deviceId"]
  }
}

클라이언트는 metadata.missingFields 값을 확인하여 누락된 필드를 사용자에게 안내하고, 필요한 정보를 다시 입력받도록 구현해야 합니다.

앱 설정 오류 처리​

APP_SETTINGS_NOT_FOUND (8010) 오류 발생 시:

  • 기본 설정값으로 앱을 초기화합니다.
  • 사용자에게 설정을 다시 구성하도록 안내합니다.
  • 필요한 경우 앱 재설치를 권장합니다.

플랫폼별 고려사항​

iOS 플랫폼​

  • iOS 버전 호환성 검증 시 최소 지원 버전을 명확히 안내합니다.
  • App Store 정책에 따른 버전 관리 가이드라인을 준수합니다.

Android 플랫폼​

  • Android API 레벨과 버전 매핑을 정확히 처리합니다.
  • 다양한 제조사별 커스텀 OS에 대한 호환성을 고려합니다.

크로스 플랫폼 고려사항​

  • 플랫폼별 기능 차이로 인한 오류를 명확히 구분하여 처리합니다.
  • 공통 기능과 플랫폼 특화 기능을 분리하여 오류 메시지를 제공합니다.

모니터링 및 로깅​

오류 발생 패턴 분석​

  • 특정 OS 버전이나 앱 버전에서 집중적으로 발생하는 오류를 모니터링합니다.
  • 플랫폼별 오류 발생률을 추적하여 개발 우선순위를 결정합니다.

사용자 경험 개선​

  • 오류 발생 시 사용자에게 명확한 해결 방법을 제시합니다.
  • 자동 복구 가능한 오류는 백그라운드에서 처리하고 사용자에게 알림을 최소화합니다.

변경 이력​

버전날짜작성자변경 내용
0.1.02025-01-20elizabeth@weltcorp.com최초 작성 - Mobile 도메인 오류 코드 문서화