Task 03 API 변경 영향 분석 실습 가이드
📥 실습 입력 (Input)
- •
day4_api_change_request.md(변경 요청서)
💾 실습 출력 (Output)
- •
change-impact-report.md(변경 영향도 분석서)
1. 스토리 및 실습 배경
서비스가 궤도에 오르면서 신규 비즈니스 스펙 변경이 하달됩니다. "기존에는 예약 생성 시점에 바로 결제 금액을 실어 보냈으나, 결제 프로세스 투명성을 위해 예약 생성 시에는 결제 금액 필드를 제외하고 예약 생성 후 별도 결제 진행 시 금액을 입력받도록 흐름을 분리해 주세요."
개발팀은 DB의 Reservations 테이블에 is_approved 컬럼을 급히 추가하고 승인 대기 상태를 넣었으나, 이 중요한 구조 변경이 프론트엔드 UI서나 기획서에는 공유되지 않고 방치되었습니다. 이로 인해 QA 단계에서 API 파라미터 누락으로 인한 장애가 대량 발생했습니다.
이번 실습에서는 스키마의 수정이 발생했을 때, 이에 연쇄적으로 영향을 받는 API 엔드포인트와 화면 설계 수정 범위를 Codex를 활용해 전수 자동 분석하고 팀원들에게 공유할 리포트를 작성하는 워크플로우를 학습합니다.
2. 학습 목표
- 데이터 구조의 변경(Schema Change) 사항이 시스템에 미치는 연쇄 여파를 추적할 수 있다.
- 변경에 의해 즉각 개정이 필요한 프론트엔드 UI서 및 화면 목록을 식별 매핑할 수 있다.
- 변경 사항 및 영향 범위를 요약하여 팀원들에게 공지할 공유 리포트를 자율 도출할 수 있다.
🛠️ 실제 따라 하기 실습 가이드
- 실습용 파일 생성: 아래 다운로드 버튼을 눌러
day4_api_change_request.md파일을 다운로드하여automation/폴더 내에 저장합니다. - Codex 분석 위임: Codex Client 프롬프트 입력창에 아래 **Codex 요청 프롬프트**를 전송하여 빌드합니다.
- 영향 보고서 점검: 생성된 보고서에서 DB 상태 세분화(Wait Approve), API Response 필드 조정, 신규 결제 API 버튼 및 상태창 조치 요구사항이 제대로 정리되었는지 확인합니다.
실습 자료 다운로드
Codex 요청 프롬프트
Task 03 Prompt
제공된 API 변경 요청서(day4_api_change_request.md) 내용을 분석하여, 예약 신청 API 수정 시 영향을 받는 다른 시스템 영역과 문서의 목록을 도출하고, 팀원들에게 즉시 작업 공유가 가능한 API 영향도 분석서를 작성해 주세요.
4. 결과물 예시
Codex는 스키마 변경 사항을 바탕으로 하위 모듈 전반의 개정 요건을 정확히 추적해 줍니다.
| 영향 영역 | 상세 변경 내용 | 리스크 수준 | 조치 대상 문서 및 명세 |
|---|---|---|---|
| API 스펙 | Reservations 테이블 status 공통 코드 세분화 (WAIT_APPROVE 상태 추가) | 높음 (High) | API 스펙 정의서 및 DDL 쿼리문 수정 |
| 프론트엔드 UI | 예약 신청 폼 화면 내 결제 금액 입력 필드 제거 또는 이관 처리 | 높음 | api-specification.md 내 관련 API 수정 |
| 신규 결제 API | 예약 상세 화면 내 '결제하기' 버튼 비활성화 상태 추가 및 '전문가 승인 대기' 정보창 추가 | 높음 | 회원 예약 화면 기획안 & UI 컴포넌트 수정 |