경계 약속
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을 각각 소비자가 처리할 수 있어야 한다.