Wat is een API-first aanpak?
De API-first aanpak contrasteert sterk met de code-first aanpak, waarbij een team begint met het ontwerpen van de functionaliteit van de applicatie, de code schrijft en API's pas aan het einde toevoegt.
Bij Zonos betekent software bouwen met een API-first aanpak dat oplossingen rond een API worden ontworpen, in plaats van een applicatie te coderen en later een API toe te voegen. Onze API's zijn daarmee van het grootste belang en producten op zich; we ontwerpen ze met intense focus op de behoeften van de klant en documenteren en architectureren ze duidelijk voordat we code schrijven.
De voordelen van een API-first aanpak
De API-first aanpak helpt de volgende mindset te vestigen:
- We begrijpen dat onze API's de primaire interface voor onze klanten zijn en beschouwen ze daarom als onze publieke deliverables.
- Documenteren vóór het schrijven van code geeft ons de kans om te redeneren, te bespreken, te verfijnen en onze doelen met teams en stakeholders te communiceren om een beter eindproduct te creëren.
- Terwijl we ons richten op de behoeften van onze klanten, begrijpen we hoe we API's het best kunnen ontwerpen die daaraan voldoen.
Deze mindset plaatst onze API's en klanten voorop en is cruciaal voor een fundament waarin iedereen bij Zonos verantwoordelijk is voor klantsucces.
Ontwikkelteams kunnen parallel werken
De API-first aanpak omvat het vaststellen van een contract. Een contract tussen services dat door teams in een organisatie wordt gevolgd, stelt die teams in staat gelijktijdig aan meerdere API's te werken. Ontwikkelaars hoeven niet te wachten tot API-updates worden uitgebracht voordat ze verdergaan met de volgende API. Teams kunnen API's en API-afhankelijkheden tegelijk mock-testen op basis van vooraf vastgestelde API-definities.
Verlaagt de ontwikkelingskosten
API's en code kunnen in veel projecten worden hergebruikt. Onder de API-first aanpak hoeft een ontwikkelteam bij een nieuwe applicatie niet vanaf nul te beginnen, wat tijd en geld bespaart. API-first design laat ook de meeste problemen oplossen voordat er code wordt geschreven, wat problemen voorkomt wanneer API's met applicaties worden geïntegreerd.
Verhoogt de time-to-market
Veel van het API-bouwproces kan worden geautomatiseerd met tools die API-definitiebestanden importeren. We beginnen met het genereren van de kerntypes, definities en schema's; met die bestanden kunnen API-tools zoals API-documentatie, software development kits (SDK's) en mock-API's automatisch worden gegenereerd. Automatisering versnelt de ontwikkeling van API's en applicaties aanzienlijk.
API-first maakt het ook mogelijk nieuwe services en technologieën aan applicaties toe te voegen zonder het hele systeem opnieuw te architectureren. Zonos moet features snel naar productie shippen om concurrerend te blijven in de snel veranderende cross-border SaaS-markt. Technische schuld in de onderliggende code elimineren is eenvoudiger dan klanten weg te migreren van een slecht ontworpen API.
Zorgt voor een goede developer experience
API-consumenten zijn meestal ontwikkelaars, en developer experience (DX) kan het succes van een API maken of breken. De API-first aanpak zorgt voor een positieve developer experience omdat een goed ontworpen, goed gedocumenteerde, consistente API gemakkelijker te leren en te hergebruiken is. Dat verhoogt ook de implementatiesnelheid. Deze voordelen zijn allemaal met elkaar verbonden!
Verhoogt langdurig succes
Een API-first aanpak maakt snelle prototyping en iteratie mogelijk, wat betekent dat we sneller leren wat werkt en wat niet. Zoals Edison's 1.000 mislukte pogingen vóór de gloeilamp, betekent API-first dat we snel falen en verdergaan met een beter begrip van hoe we succes bereiken. API-first verhoogt ons langdurige succes door te zorgen dat API's betrouwbaar, consistent en gemakkelijk te gebruiken zijn voor ontwikkelaars.
Waarom is werken met de einddoelen voor ogen effectief?
In 2015 kreeg ik de kans om de e-commercesite van een populair consumentenmerk te herontwerpen. Ik evalueerde verschillende KPI's van het bestaande systeem en het was duidelijk waar de grootste verbeteringen mogelijk waren:
- Het desktopconversiepercentage was onder de maat.
- Het mobiele conversiepercentage was abominabel.
- Het percentage mobiel verkeer steeg snel en zou binnen 12 maanden meer dan 50% van het totale verkeer zijn. Door het abominabele mobiele conversiepercentage was het feit dat het meeste verkeer mobiel was niet ideaal.
Gegeven de data, wat zou de meeste waarde voor gebruikers creëren? Het was duidelijk: de problemen met de mobiele gebruikerservaring oplossen. Daarom nam ik een mobile-first aanpak voor het herontwerp van de site. Dat betekende dat alle designs, architectuur, API's, enz. eerst de mobiele ervaring in overweging namen. Dit was omgekeerd aan de traditionele aanpak destijds, die eerst op desktop focuste en de mobiele ervaring vaak als een onhandig toegevoegde afterthought liet met slechte conversiepercentages. De mobile-first aanpak vereiste ook meer inspanning vooraf – het was niet de gemakkelijke weg. Een nieuwe architectuur was nodig, nieuwe API's moesten worden geschreven en meerdere designs waren nodig voor elk breakpoint.
De mobile-first aanpak resulteerde in een significante stijging van het mobiele conversiepercentage. De nieuwe architectuur leverde ook indrukwekkende winst op voor desktopconversie. De aanpak was succesvol omdat ze identificeerde hoe maximale gebruikerswaarde te creëren en de hele aanpak daarop richtte. Het creëerde de juiste mindset vanaf het begin. Evenzo – hoewel het als werken met de einddoelen voor ogen kan voelen – creëert een API-first aanpak kansen om overkoepelende problemen te identificeren en vervolgens een fundament te bouwen om die op te lossen.
Wat is de verantwoordelijkheid van engineering?
De API-first mindset heeft Zonos naar succes geleid en zal dat blijven doen; engineering speelt een integrale rol. Het is onze verantwoordelijkheid altijd de API-first mindset te behouden. Dat betekent dat we voortdurend vragen stellen die de focus op onze API's houden, zoals: „Hoe kunnen onze API's aan de behoeften van de klant voldoen?” Het betekent ook dat we altijd op vragen over features en functionaliteit reageren met een link naar onze API-documentatie. Als de documentatie niet bestaat, maken we die – samenwerken in cross-functionele teams om te zorgen dat Zonos uitstekende API-documentatie heeft.
Hoe een API-first aanpak de toekomst van Zonos vormgeeft
Vraagt u zich wel eens af wat het betekent om een API-first bedrijf te zijn? Lees het perspectief van Andrew Spencer, VP Engineering bij Zonos, over hoe een API-first aanpak de toekomst van Zonos vormgeeft.
Zonos is een API-first bedrijf. In die korte uitspraak zit veel informatie. Wat betekent het echt? Deze blog legt het concept van een API-first bedrijf uit zoals Zonos dat demonstreert.
Als we stellen dat Zonos een API-first bedrijf is, volgt daaruit dat onze API's de primaire strategie zijn waarmee we onze missie van vertrouwen creëren in wereldhandel realiseren. Tactisch betekent dit dat we bedrijfsbreed een API-first aanpak volgen in alles wat we doen. Wanneer we de behoeften van een klant bekijken, vragen we eerst: „Hoe kunnen onze API's aan de behoeften van de klant voldoen?”
Om beter te begrijpen wat een API-first bedrijf betekent, behandelt deze blog het volgende: