YAML to JSON Conversion: The Gotchas That Break Your Config Files

Context

YAML과 JSON은 동일한 데이터 구조(객체, 배열, 문자열, 숫자, 불린, null)를 표현하지만, YAML의 자동 타입 강제 변환과 고유 기능들로 인해 두 형식 간 변환이 예상과 다르게 작동한다. 예를 들어 국가 코드 "NO"가 불린 false로 변환되거나 버전 문자열 "1.10"이 숫자 1.1로 변환되는 등의 문제가 발생한다.

Technical Solution

• 불린 자동 강제 변환 방지: "NO", "YES", "on", "off" 등 YAML 예약어로 해석될 수 있는 문자열을 큰따옴표로 감싸기 (예: country: "NO")
• 숫자 오해석 방지: 버전 문자열이나 선행 0이 있는 값을 문자열로 명시적 선언 (예: version: "1.10", octal: "0777")
• 날짜 문자열 선명화: YAML이 ISO 8601 형식(2024-01-15)을 Date 객체로 해석하므로 필요시 문자열 명시 (예: date: "2024-01-15")
• 멀티라인 문자열 변환 규칙 적용: 리터럴 블록(|)은 개행을 \n으로 보존하고, 폴디드 블록(>)은 개행을 공백으로 변환하며, 쵸크 지시자(|+, |-)로 후행 개행 처리
• 앵커·별칭 인라인 해석: YAML의 &defaults(앵커)와 *defaults(참조), <<(병합 키)를 JSON으로 변환할 때 모든 참조를 중복 데이터로 인라인 해석
• 주석 손실 인식: YAML 주석이 JSON으로 변환되며 제거되므로 변환 전 주석의 중요도 검토

Key Takeaway

YAML 설정 파일을 JSON으로 변환할 때는 타입 강제 변환, 텍스트 표현 방식, 메타데이터(주석, 참조) 손실 등 5가지 구체적 함정을 사전에 인식하고, 발생 가능한 문제마다 명시적 타입 선언이나 검증 로직으로 대응해야 한다.