boundary agreement
API contract
API Contract
Also known as · API · endpoint contract · API agreement
Definition
An agreement that makes a provider and its consumers interpret inputs, outputs, authorization, errors, and state in the same way. It owns the observable boundary rather than a screen or implementation shape.
Searchable examples
- GET /api/search?q=term
- 401 · 403 · 404 · 409 · 500
Short example
GET /api/search?q=term
Accept: application/json
Consumers should handle 200, 400, 429, and 503 deliberately.
Terms that compare with this term
- Idempotencyretry contractThe property that repeated processing of the same intent converges on the same observable business state as one processing. It limits duplicate effects instead of pretending retries do not happen.
- Server-Sent Eventsone-way realtime deliveryA contract where a server keeps an HTTP connection open and sends text events to a client in one direction. Separate the wake-up signal from business data and define a reconnect cursor.
- Test fixtureTest Fixturetest setup stateA small bundle of input, state, and doubles prepared so one test can be reproduced under the same conditions. It differs from an evaluation dataset that represents an operational distribution.
- Tauri capabilityTauri Capabilitydesktop permission boundaryAn explicit boundary that groups the commands and permissions available to a Tauri window. It grants only the needed capabilities instead of opening a local server or filesystem broadly for convenience.