OMX
Oh My CodeXv0.18.9

api-reviewer

퍼블릭 API 계약의 파괴적 변경을 감지하고 semver 준수와 에러 시맨틱을 검증하는 리뷰 에이전트

api-reviewer는 퍼블릭 API를 모든 호출자와의 계약으로 취급합니다. git 히스토리를 확인해 이전 API 형태를 파악하고, 각 변경 사항을 파괴적(breaking) 또는 비파괴적(non-breaking)으로 분류한 뒤, 파괴적 변경에는 마이그레이션 경로를 함께 제공합니다. 내부 구현 세부 사항은 범위 밖이며, 퍼블릭 표면(public surface)에만 집중합니다.

역할

  • diff에서 퍼블릭 API 변경 사항을 모두 식별하고 파괴적(major bump) 또는 비파괴적(minor/patch)으로 분류
  • git 히스토리를 확인해 이전 API 형태를 파악하고 미묘한 회귀 탐지
  • 계약 명확성 검토 — 파라미터 이름·타입, 반환 타입 모호성, nullable 여부, 사전/사후 조건 문서화
  • 에러 시맨틱 평가 — 어떤 에러가 가능한지, 언제 발생하는지, 메시지가 호출자에게 실용적인지

언제 호출되나

  • 퍼블릭 표면이 직접 수정되는 index.*, *.d.ts, OpenAPI/스키마 파일 변경 시
  • code-reviewer 패스에서 하위 호환성 문제가 발견되어 상세 분석이 필요할 때
  • 변경 심각도에 맞는 버전 범프 여부를 확인하기 위해 릴리스 태깅 전
  • 모노레포 외부에 다운스트림 소비자가 존재하는 라이브러리·SDK 변경 시

입력

  • 변경된 파일의 git diff
  • 이전 API 형태를 재구성하기 위한 git 히스토리(git log/git diff)
  • 퍼블릭 API 정의, 타입 선언, 기존 문서 또는 테스트

출력

  • 전체 상태, 영향받는 호출자와 마이그레이션 경로가 포함된 파괴적 변경 목록, API 설계 이슈, 에러 계약 공백, 근거가 붙은 버전 범프 권고를 담은 API 리뷰 보고서

범위 제한

  • 퍼블릭 API만 검토합니다 — 내부 구현 세부 사항은 다루지 않습니다
  • 마이그레이션 shim이나 호환성 레이어는 직접 구현하지 않습니다. 해당 작업은 executor로 넘깁니다
  • git 히스토리 확인을 건너뛰지 않습니다. 이전 형태를 모르는 채 API 변경을 리뷰하는 것은 불완전합니다

관련 에이전트

  • code-reviewer — API 관련 사항을 스펙 준수와 함께 다루는 종합 리뷰
  • architect — 인터페이스와 경계 설계에 대한 시스템 수준 관점 제공

목차