Gränssnittskontrakt
Ett gränssnittskontrakt beskriver det avtalade datautbytet. Datastruktur, svar och betydelse behöver stämma överens för båda parter.
Ett gränssnittskontrakt är den överenskomna beskrivningen av hur system ska utbyta data. Det omfattar förväntade indata, svar, fel och återkopplingens betydelse. En maskinläsbar beskrivning kan uttrycka delar av detta; även verksamhetsöverenskommelser måste vara begripliga.
Dokumentera vad ett svar betyder
I en fiktiv kundportal bekräftar en lyckad överföring först bara mottagning hos en mellanliggande komponent. För att veta om ERP har skapat ordern behövs separat återkoppling. Om avsändaren tolkar det första svaret som fullständig hantering stämmer användningen inte med överenskommelsen.
Jämför beskrivning och implementering
OpenAPI definierar en standardiserad beskrivning för HTTP-API:er. Sådana beskrivningar hjälper till att förstå tillgängliga operationer och svar. De bevisar inte ensamma att en körande applikation uppfyller det avtalade flödet. Kontrollera lämpliga exempel och felfall mot implementeringen. Vid ändringar behöver det också vara tydligt vilka deltagande system som utgår från vilken överenskommelse.
Källor
Relaterade begrepp
- JSON SchemaJSON Schema beskriver struktur och begränsningar för JSON-data. En validator kontrollerar reglerna; att följa dem bevisar inte att innehållet är korrekt i sak.
- Transaktionell inboxEn transaktionell inbox använder beständiga meddelandeposter för att skydda lokal behandling mot dubbla leveranser.
- MeddelandekvittensEn meddelandekvittens talar om för brokern att en leverans har tagits emot eller behandlats enligt den överenskomna regeln.
- Jitter vid återförsökRetry-jitter varierar väntetider slumpmässigt för att sprida återförsök och minska samtidiga anrop från många klienter.
- TestkundmiljöEtt logiskt avgränsat kundområde i en multitenant-applikation, inrättat för kontroller.
- Omsändning av webhookOmsändning av webhook skickar ett meddelande igen. Avsiktlig återhämtning och replayattacker kräver olika kontroller.
Artiklar om ämnet
API:er & integration med ASES
ERP, CRM och webbutik smidigt sammankopplade