경계 약속
API 계약
API Contract
다른 이름 · API · API contract · 엔드포인트 계약
정의
API 제공자와 소비자가 입력·출력·권한·오류·상태를 같은 뜻으로 해석하도록 정한 약속이다. 화면이나 구현 코드의 모양이 아니라 관찰 가능한 경계를 소유한다.
검색되는 예
- GET /api/search?q=term
- 401 · 403 · 404 · 409 · 500
짧은 예제
GET /api/search?q=term
Accept: application/json
200, 400, 429, 503을 각각 소비자가 처리할 수 있어야 한다.
이 용어와 함께 비교되는 용어
- 멱등성Idempotency재시도 계약같은 의도를 여러 번 처리해도 관찰되는 최종 업무 상태가 한 번 처리한 결과와 같도록 만드는 성질이다. 재시도 자체를 없애는 것이 아니라 중복 효과를 제한한다.
- 서버 전송 이벤트Server-Sent Events단방향 실시간 전달서버가 HTTP 연결을 열어 둔 채 클라이언트로 텍스트 이벤트를 한 방향으로 전달하는 계약이다. 알림 신호와 업무 데이터의 원본을 분리하고 재연결 cursor를 정해야 한다.
- 테스트 픽스처Test Fixture테스트 준비 상태한 테스트를 같은 조건에서 재현하도록 미리 준비한 입력·상태·대역의 작은 묶음이다. 평가 Dataset처럼 운영 분포를 대표하는 자료와는 범위가 다르다.
- Tauri Capability데스크톱 권한 경계Tauri 앱 창이 사용할 수 있는 명령과 권한을 명시적으로 묶는 설정 경계다. 편의를 위해 로컬 서버나 파일 시스템 전체를 열기보다 필요한 능력만 허용한다.