HOW - API M2-D2

HOE

Van idee tot uitvoering

DEFINIEER

Uw vereisten

Uw functionele vereisten geven aan wat u wilt dat uw API doet. Welke zakelijke mogelijkheden biedt de API aan de klanten die deze gebruiken? Wie is uw publiek: interne ontwikkelaars, externe consumenten, of beide? Welke gegevens en functies maakt het toegankelijk en beschikbaar voor hen? Uw niet-functionele vereisten zullen doorgaans een mix zijn van beveiliging, gecontroleerde toegang en serviceniveau-aspecten zoals prestaties, beschikbaarheid en responstijd. Het omvat ook zorgen met betrekking tot gegevensbescherming en integriteit van downstream systemen.

ONTWIKKEL

Van Swagger naar proxies

Naast het geven van een betekenisvolle naam en een nuttige beschrijving aan uw API-product, is het belangrijk om functionaliteit te definiëren voor wat uw API zal doen. We specificeren de datamodellen die de verzoek- en responsberichten beschrijven. We leggen de API-interface vast met behulp van een servicebeschrijvingstaal. Om RESTful API's te beschrijven, kunnen we Swagger gebruiken. We creëren een volledig nieuw API-product dat een bestaande bron blootlegt ('proxies'). We implementeren toepasbare beveiligingsbeperkingen (beveiligingsbeleid) en zorgen voor de juiste caching, beperking van de snelheid en andere soorten gedrag. Nadat we uw API hebben ontwikkeld, is het tijd om deze te testen in een testomgeving.

IMPLEMENTEER

Laten we publiceren

Nadat uw API is getest en beoordeeld, kan deze in productie worden genomen. Enterprise-API's, inclusief cloud-API's, worden doorgaans gehost op API-gateways die ervoor zorgen dat aan de verwachte prestatie-, beveiligings- en schaalbaarheidsvereisten wordt voldaan. Om de acceptatie van de API te vergemakkelijken, publiceren we deze in een API-ontwikkelaarsportaal. We bieden duidelijke documentatie die API-functies en toepasselijke use-cases beschrijft. We leggen duidelijk eventuele API-beveiligingsbeperkingen uit die van toepassing kunnen zijn en we geven aan welke 'consumptieplannen' worden aangeboden, indien van toepassing.

BEHEER

Blijf productief

Nadat we uw API-product hebben getest en geïmplementeerd/ gepubliceerd, is het werk nog niet gedaan. We moeten nu uw API monitoren om te begrijpen hoe deze wordt gebruikt en hoe deze presteert. We bewaken de beschikbaarheid, responstijd en doorvoer, evenals statistieken zoals de betrokkenheid van ontwikkelaars en het verbruiksoverzicht. Bovendien zullen API-producten regelmatig worden geüpdatet.