Het idee
Een API biedt een verantwoordelijkheid waarop een ander systeem kan vertrouwen. Een bruikbare grens volgt een stabiele bedrijfsfunctie in plaats van de huidige indeling van databasetabellen. Daardoor kan de interne opslag veranderen zonder dat iedere afnemer moet meeveranderen.
Ontwerpkeuze
Beschrijf de bedoeling van de aanroeper, de benodigde informatie en het waarneembare resultaat. Houd interne processtappen intern, tenzij afnemers ze daadwerkelijk moeten besturen. Publiceer fouten die helpen om een vervolgstap te kiezen.
Uitgewerkt voorbeeld
Een catalogusdienst ontvangt een verzoek om een product te publiceren. De dienst controleert verplichte velden en geeft een publicatie-ID terug. De aanroeper werkt niet zelf drie interne tabellen bij en is niet afhankelijk van hun namen.
Voor ingebruikname
- Benoem de functie in de taal van de afnemer.
- Documenteer geslaagde en mislukte uitkomsten.
- Test een opslagwijziging zonder het openbare contract te veranderen.
De voorbeelden zijn illustratief. Pas de controles aan uw eigen omgeving aan.