Interfacecontract

Een interfacecontract is de afgesproken beschrijving van hoe systemen gegevens moeten uitwisselen. Daarbij horen verwachte invoer, antwoorden, fouten en de betekenis van die terugmeldingen. Een machineleesbare beschrijving kan delen hiervan uitdrukken; zakelijke afspraken moeten ook begrijpelijk zijn.

Leg de betekenis van een antwoord vast

In een fictief klantenportaal bevestigt succesvolle overdracht aanvankelijk alleen ontvangst door een tussencomponent. Er is een aparte terugmelding nodig om te weten of het ERP de order heeft aangemaakt. Als de verzender het eerste antwoord al als volledige afhandeling opvat, past zijn gebruik niet bij de afspraak.

Vergelijk beschrijving en implementatie

OpenAPI definieert een gestandaardiseerde beschrijving voor HTTP-API’s. Zulke beschrijvingen helpen beschikbare bewerkingen en antwoorden te begrijpen. Ze bewijzen op zichzelf niet dat een draaiende toepassing het afgesproken verloop vervult. Controleer passende voorbeelden en foutgevallen tegen de implementatie. Bij wijzigingen moet ook duidelijk zijn welke deelnemende systemen van welke afspraak uitgaan.

Bronnen

• OpenAPI Initiative: OpenAPI Specification