Qu'est-ce qu'une approche API-first ?
L'approche API-first contraste fortement avec l'approche code-first, où une équipe commence par concevoir les fonctionnalités de l'application, écrire le code, puis ajouter les API à la fin du processus.
Chez Zonos, construire des logiciels avec une approche API-first signifie concevoir des solutions autour d'une API, plutôt que de coder une application et d'ajouter une API par la suite. Cela signifie que nos API sont primordiales et des produits à part entière ; nous les concevons avec une attention intense portée aux besoins du client, et nous les documentons et les architecturons clairement avant d'écrire la moindre ligne de code.
Les avantages d'une approche API-first
L'approche API-first aide à établir l'état d'esprit suivant :
- Nous comprenons que nos API sont l'interface principale pour nos clients, et nous les considérons donc comme nos livrables publics.
- Documenter avant d'écrire le code nous donne l'occasion de raisonner, de discuter, d'affiner et de communiquer nos objectifs avec nos équipes et nos parties prenantes pour créer un meilleur produit final.
- En nous concentrant sur les besoins de nos clients, nous comprenons comment concevoir au mieux des API qui répondent à ces besoins.
Cet état d'esprit place nos API et nos clients en premier et est essentiel pour établir une base où chacun chez Zonos est responsable du succès client.
Les équipes de développement peuvent travailler en parallèle
L'approche API-first implique l'établissement d'un contrat. Créer un contrat entre les services suivi par les équipes de toute l'organisation permet à ces équipes de travailler sur plusieurs API simultanément. Les développeurs n'ont pas à attendre la publication des mises à jour d'API avant de passer à la suivante. Les équipes peuvent simultanément simuler et tester les API et leurs dépendances sur la base de définitions d'API préétablies.
Réduit le coût de développement
Les API et le code peuvent être réutilisés dans de nombreux projets différents. Avec l'approche API-first, si une équipe de développement souhaite construire une nouvelle application, elle n'a pas à repartir de zéro, ce qui permet d'économiser du temps et de l'argent. La conception API-first permet également de résoudre la plupart des problèmes avant même d'écrire du code, ce qui aide à prévenir les problèmes au moment d'intégrer les API aux applications.
Accélère la mise sur le marché
Une grande partie du processus de construction des API peut être automatisée à l'aide d'outils pour importer des fichiers de définition d'API. Nous commençons par générer les types, définitions et schémas de base ; avec ces fichiers, des outils API tels que la documentation API, les kits de développement logiciel (SDK) et les API simulées peuvent être générés automatiquement. L'automatisation accélère considérablement le développement des API et des applications.
L'API-first permet également d'ajouter de nouveaux services et technologies aux applications sans avoir à réarchitecturer l'ensemble du système. Zonos doit déployer des fonctionnalités en production rapidement pour rester compétitif sur le marché SaaS transfrontalier en constante évolution. Il est plus facile d'éliminer la dette technique dans le code sous-jacent que de migrer les clients loin d'une API mal conçue.
Garantit une bonne expérience développeur
Les consommateurs d'API sont le plus souvent des développeurs, et l'expérience développeur (DX) peut faire ou défaire le succès d'une API. L'approche API-first garantit une expérience développeur positive, car une API bien conçue, bien documentée et cohérente est plus facile à apprendre et à réutiliser. Cela accélère également la vitesse de mise en œuvre. Tous ces avantages sont interconnectés !
Augmente le succès à long terme
Une approche API-first permet un prototypage et une itération rapides, ce qui signifie que nous apprenons plus vite ce qui fonctionne et ce qui ne fonctionne pas. Comme les 1 000 tentatives ratées d'Edison avant de créer l'ampoule, API-first signifie que nous échouons vite et avançons avec une meilleure compréhension de la façon d'atteindre le succès. L'API-first augmente notre succès à long terme en garantissant que les API sont fiables, cohérentes et faciles à utiliser pour les développeurs.
Pourquoi travailler à rebours est-il efficace ?
En 2015, j'ai eu l'opportunité de repenser le site ecommerce d'une marque grand public populaire. J'ai évalué divers indicateurs clés de performance (KPI) liés au système existant, et il était clair où les plus grandes améliorations pouvaient être apportées :
- Le taux de conversion desktop était inférieur à la norme.
- Le taux de conversion mobile était catastrophique.
- Le pourcentage de trafic mobile augmentait rapidement et dépasserait 50 % du trafic total dans les 12 mois suivants. En raison du taux de conversion mobile catastrophique, le fait que la majorité du trafic soit mobile n'était pas idéal.
Compte tenu des données, qu'est-ce qui créerait le plus de valeur pour les utilisateurs ? C'était évident : corriger les problèmes de l'expérience utilisateur mobile du site. J'ai donc adopté une approche mobile-first pour repenser le site. Cela signifiait que tous les designs, l'architecture, les API, etc. considéraient d'abord l'expérience mobile. C'était à l'inverse de l'approche traditionnelle de l'époque, qui se concentrait d'abord sur l'expérience desktop, laissant souvent l'expérience mobile comme une réflexion après coup maladroite avec de mauvais taux de conversion. L'approche mobile-first demandait également plus d'efforts en amont — ce n'était pas la voie facile. Une nouvelle architecture était nécessaire, de nouvelles API devaient être écrites, et plusieurs designs étaient requis pour chaque point de rupture.
L'approche mobile-first a entraîné une augmentation significative du taux de conversion mobile. La nouvelle architecture a également produit des gains impressionnants en taux de conversion desktop. L'approche a réussi parce qu'elle a identifié comment créer une valeur maximale pour les utilisateurs et a concentré l'ensemble de l'approche sur la fourniture de cette valeur. Elle a créé le bon état d'esprit dès le départ. De même — bien que cela puisse sembler travailler à rebours — une approche API-first crée des opportunités d'identifier les problèmes globaux, puis de construire une fondation pour les corriger.
Quelle est la responsabilité de l'ingénierie ?
L'état d'esprit API-first a mené et continuera de mener Zonos vers le succès, et l'ingénierie joue un rôle essentiel. Il est de notre responsabilité de toujours maintenir l'état d'esprit API-first. Cela signifie que nous posons constamment des questions qui maintiennent l'attention sur nos API, telles que : « Comment nos API peuvent-elles répondre aux besoins du client » Cela signifie également que nous répondons toujours aux questions sur les fonctionnalités avec un lien vers notre documentation API. Si la documentation n'existe pas, nous la créons — en travaillant ensemble au sein d'équipes transversales pour garantir que Zonos dispose d'une documentation API exceptionnelle.
Comment une approche API-first façonne l'avenir de Zonos
Vous vous demandez ce que signifie être une entreprise API-first ? Découvrez le point de vue d'Andrew Spencer, VP Engineering chez Zonos, sur la façon dont une approche API-first façonne l'avenir de Zonos.
Zonos est une entreprise API-first. Cette courte phrase recèle beaucoup d'informations. Alors, qu'est-ce que cela signifie vraiment ? Ce blog décompose le concept d'une entreprise API-first tel qu'il est illustré par Zonos.
Si nous affirmons que Zonos est une entreprise API-first, il s'ensuit que nos API sont la stratégie principale par laquelle nous accomplissons notre mission de créer la confiance dans le commerce mondial. Tactiquement, cela signifie que nous devons adopter une approche API-first à l'échelle de l'entreprise pour tout ce que nous faisons. Lorsque nous examinons les besoins d'un client, nous nous demandons d'abord : « Comment nos API peuvent-elles répondre aux besoins du client ? »
Pour mieux comprendre ce que signifie être une entreprise API-first, ce blog abordera les sujets suivants :