클러스터 C1: JSON 생태계
JSON Schema 검증 체크리스트
API 또는 설정 변경을 배포하기 전에 JSON Schema 로 필수 필드, 예시, 회귀 검증을 맞추기 위한 실무 체크리스트입니다.
먼저 계약을 고정하세요
Schema 는 단순히 검증기를 통과하기 위한 문서가 아니라 필수 필드, nullable 정책, enum 범위를 팀 전체가 동일하게 이해하기 위한 기준입니다.
문서, 예시 payload, 실제 검증 규칙이 어긋나면 문제는 개발 중보다 통합 테스트나 릴리스 직전에 더 크게 드러납니다.
배포 전에 확인할 핵심 항목
- required, type, enum, format 이 실제 API 제약과 일치하는지 확인합니다.
- 중첩 객체와 배열에 대해 성공 예시와 실패 예시를 각각 준비합니다.
- Schema 검증을 CI 에 넣어 리뷰 단계의 누락을 줄입니다.
실무 입력/출력 예시
입력
{
"type": "object",
"required": ["id", "status"],
"properties": {
"id": { "type": "string" },
"status": { "enum": ["ready", "failed"] }
}
}출력
검증 결과: - payload.id 가 없으면 실패 - payload.status 는 ready / failed 만 허용