JSON API 데이터 계약 설계 요점
출시 후 바꾸기 매우 어려운 여섯 가지가 있습니다. 응답 봉투, 오류 형식, 페이지네이션 모양, ID와 시간의 표현, null 대 누락의 의미, 버전 진화입니다.
중급약 13분 소요2026-10-30 업데이트
JSON을 실제 시스템에 넣기: API 계약을 정의하는 방법, 설정과 픽스처를 관리하는 방법, 버전 호환성을 처리하는 방법, 테스트 데이터를 유지하는 방법.
5개 문서출시 후 바꾸기 매우 어려운 여섯 가지가 있습니다. 응답 봉투, 오류 형식, 페이지네이션 모양, ID와 시간의 표현, null 대 누락의 의미, 버전 진화입니다.
설정은 계층화하고 검증해야 하며, 픽스처는 결정적이고 읽기 쉽고 diff 가능해야 합니다. 이 두 종류의 파일을 잘못 관리하면 문제 해결 비용이 오래 높게 유지됩니다.
레코드 50개가 51개가 되면 diff가 51개 변경을 보고합니다. 텍스트 diff의 거짓 양성, id로 배열 매칭, jq 정규화, 적용 가능한 패치를 다룹니다.
merge=union은 깨진 JSON을 통과시키면서 성공을 보고합니다. JSON을 위한 키 인식 3방향 머지 드라이버와 충돌을 줄이는 세 가지 습관을 안내합니다.
필드를 더한다고 자동으로 안전하지 않습니다. 호환성 경계, 버전 필드, 폐기 창, 듀얼 쓰기 이전, 계약 테스트, 카나리 지표를 다룹니다.