SR

2024-12-18

API 변경 알림을 PR 앞당기기

글쓴이 최민석

API 변경 알림을 PR 앞당기기 대표 이미지

API 변경은 UI보다 먼저 깨지는 경우가 많습니다. 그러나 스키마 diff만으로는 “이번 변경이 사용자에게 보이는가?”를 설명하기 어렵습니다. 저희 워크숍에서는 diff 결과를 사용자 여정의 단계에 매핑하는 표를 함께 만듭니다.

첫 번째 단계는 엔드포인트를 사용자 여정의 순서로 재배열하는 것입니다. 두 번째 단계는 각 단계마다 “깨지면 롤백인가, 모니터링인가”를 태그로 남기는 것입니다. 세 번째 단계는 Newman 리포트에 그 태그를 노출해 리뷰어가 빠르게 훑게 합니다.

이 방식은 대규모 마이그레이션에는 한계가 있습니다. 모든 엔드포인트를 한 번에 옮기면 표 자체가 거대해지기 때문입니다. 이럴 때는 한 주에 하나의 사용자 여정만 다루는 것이 안전합니다.

마지막으로, 계약 테스트는 혼자 완성되지 않습니다. 백엔드 리뷰어와 QA가 같은 diff 언어를 쓰도록 작은 용어집을 유지하는 것이 중요합니다.

API계약CI
← 목록으로