REST API’s ontwikkelen: 3 benaderingen

We schreven al eerder over hoe je een goede REST API definieert en of je je REST API zelf ontwikkelt of gebruikmaakt van een integratieframework. In dit blogartikel benoemen we drie belangrijke benaderingen voor het ontwikkelen van een REST API: vanuit een blauwdruk, met behulp van een framework en vanuit je afnemer.

1. 
   1. Ontwikkel vanuit een blauwdruk van je API en landschap

Je kiest ervoor om eerst een ontwerp, een blauwdruk, te maken van je landschap en daarna API's te ontwikkelen óf voor het ontwikkelen van een API in kleine stappen. De kans dat je API uniform of herbruikbaar wordt, is heel klein, wanneer je je API gefragmenteerd ontwikkelt. Je geeft namelijk je REST API vorm voor een enkele vraag en bij het ontwerp hou je geen rekening met een volgende vraag. Deze vorm van ontwikkelen is handig wanneer je niet goed weet hoe REST werkt, zodat je leert door stap voor stap te bouwen.

Wanneer je ervoor kiest om wel eerst een ontwerp te maken, kost je dat in het begin veel meer tijd. Maar je krijgt wel een indruk van hoe de organisatie in elkaar zit en welke afnemers er zijn. Beschrijf op objectniveau de interfaces, hoe deel je deze in? Door eerst een blauwdruk te maken, krijg je een overzicht van je concept API. Dat heeft veelal onze voorkeur, omdat je dan veel slimmer kunt gaan bouwen.

1. 2. Ontwikkel REST API met een framework

2. Tegenwoordig valt bijna alles onder het begrip 'framework'. Je hebt het Spring Framework voor Java, dat bijvoorbeeld al een deel van de documentatie van je API levert. Dit Spring Framework is weer onderdeel van een integratieframework (of integratielaag). Die laatste scheidt het functionele deel van je API van het technische deel. Een integratieframework levert je bouwblokken voor je API die kant-en-klaar en getest zijn.

Je kunt een API rechtstreeks vanuit Spring inzetten of je zet er een API Gateway of integratielaag voor. De Gateway kun je zien als een soort filter: wat mag er wel en niet naar buiten? Dat kan bijvoorbeeld gaan over het beschikbaar stellen van bepaalde documentatie aan externe klanten van je API. De integratielaag biedt je het voordeel dat veel functionaliteiten en standaardkoppelingen al zijn ontwikkeld en maakt je API direct beheersbaar. Het is zeker aan te raden om een framework te gebruiken om je REST API te ontwikkelen en te implementeren.

2. 3. Ontwikkel REST API vanuit je afnemer

Een REST API bouw je voor een specifieke afnemer: vaak een applicatie of een eindgebruiker. Het is belangrijk dat je dat voor jezelf helder hebt, want een API doesn't fit all. Wanneer je een API ontwikkelt voor een eindgebruiker, kun je caching toepassen, zodat informatie sneller wordt geladen. Maar voor een API tussen applicaties is dat mechanisme niet nodig. Of denk aan autorisatie: een eindgebruiker is vaak niet geautoriseerd om alle informatie in te zien, terwijl een API tussen applicaties vaak gewoon alle gegevens deelt. Bovendien weet een applicatie heel specifiek wat hij vanuit de andere applicatie nodig heeft. Een eindgebruiker is vaak nog op ontdekkingstocht. Wie je afnemer is, bepaalt dus hoe je je REST API bouwt.

E-BOOK: DE 10 PRINCIPES VAN SYSTEEMINTEGRATIE TOEGEPAST

Een overzichtelijke, stabiele en beheersbare infrastructuur, daar wil je naartoe met een systeemintegratie. Tot dit resultaat kom je met een flexibele integratielaag, inzicht in de behoeften van je business en datastromen en door alvast na te denken wat er moet gebeuren na de integratie. Wil je hier meer over lezen? Download ons e-book.