Grænsefladekontrakt
En grænsefladekontrakt beskriver den aftalte dataudveksling. Datastruktur, svar og betydning skal passe sammen for begge parter.
En grænsefladekontrakt er den aftalte beskrivelse af, hvordan systemer skal udveksle data. Den omfatter forventede input, svar, fejl og betydningen af tilbagemeldingerne. En maskinlæsbar beskrivelse kan udtrykke dele af det; forretningsmæssige aftaler skal også være forståelige.
Fastlæg, hvad et svar betyder
I en fiktiv kundeportal bekræfter en vellykket overførsel først kun modtagelse hos en mellemkomponent. Det skal fremgå af en særskilt tilbagemelding, om ERP har oprettet ordren. Hvis afsenderen allerede tolker det første svar som fuldstændig afslutning, passer brugen ikke til aftalen.
Sammenhold beskrivelse og implementering
OpenAPI definerer en standardiseret beskrivelse af HTTP-API’er. Sådanne beskrivelser hjælper med at forstå tilgængelige operationer og svar. De beviser ikke alene, at en kørende applikation opfylder det aftalte forløb. Kontrollér passende eksempler og fejltilfælde mod implementeringen. Ved ændringer skal det desuden være klart, hvilke deltagende systemer der tager udgangspunkt i hvilken aftale.
Kilder
Relaterede begreber
- JSON SchemaJSON Schema beskriver struktur og begrænsninger i JSON-data. En validator kontrollerer reglerne; overholdelse beviser ikke i sig selv forretningsmæssig korrekthed.
- Transaktionel inboxEn transaktionel inbox bruger varige meddelelsesregistreringer til at beskytte lokal behandling mod dobbelte leveringer.
- MeddelelseskvitteringEn meddelelseskvittering fortæller brokeren, at en levering er modtaget eller behandlet efter den aftalte regel.
- Jitter ved genforsøgRetry-jitter varierer ventetider tilfældigt for at sprede genforsøg og mindske samtidige forespørgsler fra mange klienter.
- TestkundemiljøEt logisk afgrænset kundeområde i en multitenant-applikation, indrettet til kontroller.
- Genafsendelse af webhookGenafsendelse af webhook sender en meddelelse igen. Bevidst genopretning og replay-angreb kræver forskellige kontroller.
Artikler om emnet
Snitflader & integration med ASES
ERP, CRM og webshop forbundet ordentligt