API 계약 변경의 영향을 검토하는 프롬프트

언제 사용하나

공개 API(요청/응답 스펙)를 바꾸기 전에 하위 호환성 영향을 검토할 때.

요청 전 확인

• 변경 전/후 스펙과 이 API를 쓰는 소비자를 파악한다.

복사해서 쓰는 프롬프트

아래 API 계약 변경의 영향을 검토해줘.

현재 스펙: {{BEFORE}}
변경 후 스펙: {{AFTER}}
소비자/클라이언트: {{CONSUMERS}}

원하는 출력:
1. breaking change 여부와 어떤 소비자가 깨지는지
2. 하위 호환을 유지하는 대안(필드 추가/버전 분리/기본값)
3. 불가피한 변경이라면 마이그레이션·공지 계획
4. 계약 테스트로 회귀를 막는 방법

placeholder 설명

• {{BEFORE}} / {{AFTER}} : 변경 전/후 스펙
• {{CONSUMERS}} : 소비자 목록

입력 예시

{{AFTER}} = 응답 필드 이름 변경

기대 결과

breaking 여부, 호환 대안, 마이그레이션 계획.

검증 방법

계약 테스트로 기존 소비자 시나리오가 유지되는지 확인한다.

주의사항

• 필드 삭제·이름 변경은 대표적인 breaking change다.

관련 문서

• Semantic Versioning: https://semver.org/lang/ko/