Gestion du cycle de vie des API : Qu‘est-ce que c‘est et comment le mettre en œuvre ?

17 minutes de lecture

Le marché des API devrait passer de 4,1 milliards de dollars en 2021 à 8,14 milliards de dollars en 2027. Cette croissance massive montre à quel point l‘utilisation des API - tant internes qu‘externes - augmente.

Cette croissance de l‘utilisation des API pose également des défis en matière de gestion des API. Les entreprises ont des API internes, des API externes et des API de tiers qui fonctionnent simultanément. Elles doivent produire et acquérir de nouvelles API, mettre à jour les API existantes et retirer les API obsolètes. Pour que l‘utilisation des API soit efficace, il faut une stratégie de gestion de toutes les API. C‘est pourquoi vous avez besoin d‘une gestion du cycle de vie des API. La gestion du cycle de vie des API est un ensemble de processus qui aide les développeurs à organiser les API depuis la phase de planification jusqu‘à la phase finale, où une API est retirée.

Pour une gestion efficace des API, définissez des règles pour chaque étape et utilisez une passerelle API, un portail pour les développeurs et un tableau de bord pour gérer toutes vos API de manière transparente.

Quelles sont les étapes du cycle de vie d‘une API ?

Il n‘existe pas de consensus général sur le nombre total d‘étapes du cycle de vie d‘une API. Certains le divisent en cinq, d‘autres en trois, d‘autres encore en huit, etc. En nous basant sur le nombre de fois où les API passent par le processus de changement d‘état, nous avons divisé le cycle de vie de l‘API en 10 étapes :

1. La planification

L‘étape de planification est celle où le développeur définit la raison pour laquelle il construit l‘API. Lorsque les parties prenantes de l‘entreprise demandent de nouvelles caractéristiques et fonctionnalités pour le produit, l‘équipe de développement rassemble les exigences et fixe des objectifs pour l‘API en fonction de ces besoins.

C‘est également à ce stade que les développeurs créent de nombreux diagrammes sur un tableau blanc ou une application de dessin afin de visualiser le fonctionnement de l‘API et la manière dont elle s‘intégrera dans l‘écosystème de l‘API.

2. Conception

L‘étape de la conception est celle où l‘architecture de l‘API est définie. Cette étape est importante car la personne qui conçoit l‘API ne la construira pas nécessairement. La conception doit être normalisée pour être facilement compréhensible par tous les membres de l‘équipe.

Il existe quatre architectures d‘API :

  • REST: Representational State Transfer, utilisé pour les applications web et mobiles.
  • SOAP: Simple Object Access Protocol, utilisé dans les systèmes d‘exploitation.
  • RPC: Remote Procedure Call (appel de procédure à distance), utilisé pour les applications distribuées.
  • GraphQL: Graph Query Language, utilisé dans les applications mobiles.

Parmi les quatre types, REST et SOAP sont les plus utilisés.

Vous concevez des API REST à l‘aide de la spécification OpenAPI (OAS) - un format qui décrit la syntaxe et la structure de l‘API, quel que soit le langage de programmation utilisé pour construire l‘API. Vous rédigez les spécifications en YAML ou JSON et vous veillez à ce que l‘API soit conforme aux directives de conception de l‘organisation.

L‘idée et les processus restent les mêmes pour les API SOAP, mais au lieu des spécifications OpenAPI, vous utilisez le WSDL (Web Services Description Language ), un langage de description d‘interface basé sur XML, pour rédiger les spécifications de l‘API.

3. Bâtiment

À ce stade, le développeur qui travaille sur l‘API sait ce que l‘API est censée faire et comment elle est censée fonctionner. Toutes les informations issues des phases de planification et de conception sont documentées et accessibles à la personne qui construit l‘application. C‘est au cours de la phase de construction que les développeurs écrivent le code et donnent vie à l‘API. Voici quelques-unes des activités standard réalisées au cours de cette phase.

  • Standardisation des réponses à tous les types de demandes, telles que 202 : Demande acceptée et 404 : Ressource non trouvée.
  • Construire le point de terminaison de l‘API, qui est l‘URL où les demandes d‘API sont reçues.
  • Spécification du type de requête que le point d‘accès peut recevoir, par exemple (GET, POST, PUT, PATCH, DELETE).
  • Pagination pour les requêtes GET, de sorte que si la requête de recherche renvoie 10 000 résultats, l‘interface montre la page 1 sur 100 et affiche les 100 premiers résultats.
  • Mise en place d‘un système de cache côté client pour des performances plus rapides, car certaines ressources peuvent être mises en cache côté client afin de réduire la charge du serveur.

Une fois l‘API développée, elle passe par le processus de test, où des outils tels que SOAPUI et REST-assured sont utilisés pour les API SOAP et REST, respectivement.

4. Sécurisation

La sécurisation suit de près la phase de construction. À ce stade, les développeurs chiffrent les points de terminaison de l‘API à l‘aide de certificats SSL. Cela permet d‘éviter les attaques de pirates qui tentent d‘obtenir les noms des serveurs, des frameworks, des versions et d‘autres informations sensibles.

L‘authentification et l‘autorisation des utilisateurs sont sécurisées par OAuth 2.0. L‘authentification de l‘utilisateur devient encore plus importante lorsqu‘il s‘agit d‘API externes. En effet, toute personne ayant accès à l‘API peut la cibler pour attaquer le système. Avec des méthodes d‘authentification appropriées, seules les personnes autorisées peuvent utiliser votre API. Pour les API publiques et les API externes, des limites de demande et de taille de demande sont définies pour protéger l‘API contre les attaques DDoS.

5. Le versionnage

Le versionnage implique que les développeurs apportent des modifications à l‘API et en créent une nouvelle version améliorée. Le versionnage est nécessaire parce que vous pourriez avoir besoin de.. :

  • Inclure un nouveau type de données qui peuvent être renvoyées en réponse à des demandes.
  • Ajouter ou supprimer des types de demande et de réponse.
  • Ajouter des points d‘extrémité.

Après le déploiement de la nouvelle version, l‘ancienne version est progressivement réduite et retirée.

En général, les développeurs incluent le numéro de version de l‘API dans son chemin d‘accès URI (Uniform Resource Identifier). Le chemin URI est utilisé pour identifier l‘API. La convention de dénomination utilise le format "MAJOR.MINOR.PATCH" en plus de l‘URI. Ainsi, si une API a 2.4.10 à côté de son nom, cela signifie qu‘il s‘agit de la deuxième version majeure, de la quatrième version mineure de la deuxième version et du dixième correctif. De même, 1.0.0 est la première version majeure et stable d‘une API.

6. L‘édition

Publier une API signifie la mettre à la disposition des utilisateurs pour qu‘ils la consomment. Ces utilisateurs peuvent être les membres de votre équipe dans le cas d‘API internes, vos partenaires et clients dans le cas d‘API externes, ou n‘importe qui dans le monde dans le cas d‘une API publique. En publiant l‘API, vous passez à la version stable.

7. Catalogage

À ce stade, les développeurs ajoutent l‘API au catalogue d‘API de leur entreprise - la bibliothèque de toutes les API de votre organisation. Le catalogue doit également contenir la documentation pertinente relative à la planification, à la conception, à la construction, aux versions et aux autres étapes du cycle de vie de l‘API.

Le catalogage permet de centraliser et d‘organiser l‘infrastructure des API au sein de votre organisation. Il permet également aux nouveaux développeurs de travailler plus facilement avec les API et de créer de nouvelles versions, car toutes les informations de base dont ils ont besoin sont disponibles en un seul endroit.

8. Observer

Une fois qu‘une API est publiée et que les gens commencent à l‘utiliser, les développeurs mettent en place une surveillance pour garder un œil sur sa disponibilité, son utilisation et ses performances afin de s‘assurer qu‘elle fonctionne comme prévu. Parmi les mesures utilisées pour observer les performances d‘une API figurent le temps de fonctionnement, le temps d‘arrêt, les consommateurs uniques de l‘API, les demandes par minute et les erreurs par minute.

Pour suivre l‘analyse des API, vous pouvez soit créer une solution personnalisée, soit utiliser des outils tels que SnapLogic APIM.

9. Mise à l‘échelle

Plus il y a de personnes qui utilisent votre API, plus votre serveur a besoin de ressources. L‘augmentation du nombre d‘utilisateurs s‘accompagne d‘un plus grand nombre de requêtes et d‘une plus grande utilisation de l‘unité centrale et de la mémoire. Pour vous assurer que votre API peut gérer un nombre croissant d‘appels d‘utilisateurs, vous pouvez opter pour une mise à l‘échelle verticale, c‘est-à-dire ajouter continuellement de la mémoire et des processeurs plus rapides. Cependant, l‘extension verticale peut devenir coûteuse au fil du temps, car vous achetez sans cesse du nouveau matériel.

La mise à l‘échelle horizontale est une meilleure alternative à la mise à l‘échelle verticale. Vous ajoutez de nouveaux serveurs, vous hébergez votre API sur plusieurs serveurs et vous utilisez l‘équilibrage de charge pour vous assurer que tous les serveurs sont utilisés de la même manière en termes d‘utilisation de l‘unité centrale et de la mémoire. De cette manière, les coûts restent sous contrôle, car vous n‘avez pas besoin d‘acheter du nouveau matériel aussi fréquemment, et vos ressources sont utilisées de manière efficace.

10. Retraite

Les API sont généralement retirées lorsqu‘une meilleure version est disponible, lorsqu‘il y a des problèmes de sécurité ou trop de bogues, ou lorsqu‘il n‘est tout simplement pas viable de les maintenir en vie. Dans tous les cas, communiquez la décision de retirer l‘API à tous ceux qui l‘utilisent. Avant de retirer l‘API Contacts en janvier 2022, Google a annoncé que l‘API était obsolète depuis septembre 2020, ce qui a donné aux utilisateurs plus d‘un an pour s‘adapter.

Un versionnement approprié facilite également le retrait d‘une API, car vous pouvez simplement demander à vos utilisateurs de passer à la version recommandée et leur donner quelques mois pour le faire. Lorsque les versions sont cataloguées correctement, vous pouvez toujours revenir en arrière et passer à une version plus ancienne si nécessaire. Le fait de disposer de versions plus anciennes et retirées à des fins d‘analyse peut également aider à résoudre des problèmes récurrents avec différentes versions de l‘API.

4 outils pour une gestion efficace du cycle de vie des API

Utilisez les outils suivants pour vous assurer que vos API répondent aux exigences commerciales et de conformité et qu‘elles sont réutilisables, accessibles et cohérentes.

1. Portail des développeurs

Un portail pour développeurs est un référentiel d‘informations destiné aux développeurs externes et internes qui utilisent vos API. Il s‘agit d‘un magasin de données et d‘applications en libre-service qui contient toutes les informations techniques sur l‘ensemble des API de votre organisation.

Votre portail pour les développeurs doit contenir de la documentation et des guides sur les API, ainsi qu‘un forum où les développeurs peuvent poser des questions et participer à des discussions.

  • La documentation vous aidera à franchir les dix étapes du cycle de vie de l‘API. Tout développeur qui doit apporter des modifications à une API peut accéder au portail des développeurs et obtenir toutes les informations de base dont il a besoin.
  • Un forum au sein du portail les aidera à interagir avec d‘autres développeurs qui travaillent avec les mêmes API ou des API similaires. Pour les petites équipes, un forum peut ne pas être nécessaire. Toutefois, si vous proposez des API externes et que des partenaires et des clients de différentes organisations utilisent ces API, un forum peut s‘avérer utile.
  • Le portail destiné aux développeurs doit comporter un catalogue d‘API central dans lequel vos développeurs peuvent accéder à toutes vos API actuelles. Si vous avez des centaines d‘API internes en production, un catalogue d‘API vous aidera à les gérer facilement.

Dans certains cas, les utilisateurs finaux externes n‘ont accès qu‘au forum et aux définitions de l‘API. Ces utilisateurs disposent généralement d‘un moyen de contacter les développeurs de l‘API en cas de problème. Les développeurs de l‘API surveillent le forum et répondent aux questions des utilisateurs.

Vous pouvez utiliser un portail de développement personnalisable comme Blobr ou créer votre propre portail pour vous aider à cataloguer et à documenter vos API.

2. Passerelle API

Une passerelle API est un outil qui découple l‘interface orientée vers l‘utilisateur final du back-end de l‘API. Elle décompose les demandes individuelles des utilisateurs en plusieurs requêtes, les envoie aux bons systèmes, rassemble les ressources en fonction de la demande et renvoie la réponse. La passerelle gère également l‘authentification des utilisateurs, la surveillance et l‘analyse, ainsi que la limitation du débit. Dans les systèmes à fort volume, où des centaines, des milliers ou des dizaines de milliers de demandes arrivent, il est utile de découpler la gestion des demandes et le traitement des demandes.

Vous pouvez gérer une ou deux API sans passerelle API, mais une passerelle devient nécessaire avec plusieurs API. Vous bénéficiez d‘une sécurité supplémentaire, car les points d‘extrémité d‘API sensibles ne sont pas exposés. Les passerelles API gèrent également la limitation du débit, l‘authentification et l‘autorisation des utilisateurs, ainsi que la mise à l‘échelle.

Une passerelle API s‘avère également utile lorsque l‘équipe utilise l‘approche DevOps, une architecture microservices ou un modèle sans serveur.

Dans l‘approche DevOps, de nouvelles versions de plusieurs API sont continuellement construites, testées, déployées et surveillées. Chaque fois qu‘une nouvelle version est déployée, la définition de l‘API - qui se trouve dans la passerelle API - doit également être mise à jour. La passerelle met automatiquement à jour les définitions d‘API lorsque de nouvelles versions sont déployées.

Dans une architecture microservices, les applications sont conçues comme un groupe de services faiblement couplés et pouvant être déployés de manière indépendante. Supposons qu‘un utilisateur souhaite obtenir des informations complètes sur un produit à partir d‘une application utilisant une architecture microservices. Sa demande de récupération de ces informations devra être fractionnée en plusieurs requêtes car, dans une architecture microservices, les informations complètes sur un produit ne résident pas en un seul endroit. Dans les systèmes à fort volume qui n‘utilisent pas de passerelle API, les développeurs devront élaborer une solution personnalisée pour fragmenter ces demandes. Étant donné que les passerelles API divisent les demandes entrantes en demandes plus petites, l‘architecture microservices et les passerelles API fonctionnent bien ensemble.

Un modèle sans serveur ou une architecture d‘application sans serveur est un moyen de créer des applications sur le site cloud. Les développeurs qui utilisent ce modèle ne gèrent pas les serveurs ; le fournisseur cloud met en place les serveurs et les configure et les fait évoluer en fonction des besoins. Les passerelles API fonctionnent avec des frameworks sans serveur et peuvent être configurées pour équilibrer les charges de demande en dirigeant des demandes spécifiques vers des serveurs virtuels spécifiques.

Les passerelles API constituent un point d‘entrée unique pour toutes les demandes des utilisateurs, et c‘est pourquoi elles peuvent constituer un point de défaillance unique. Réduisez ce risque en configurant votre passerelle API pour un cluster à haute disponibilité. Les grappes à haute disponibilité se composent de magasins de données distribués et de plusieurs instances du service de passerelle fonctionnant sur plusieurs serveurs. Plus il y a de serveurs dans la grappe, plus vous réduisez le risque de panne du système.

Vous pouvez utiliser la passerelle API de SnapLogic ou créer votre propre passerelle.

3. Tableau de bord API

Un tableau de bord API, qui vous permet de visualiser l‘utilisation de l‘API et les principales mesures de l‘API, vous aide à identifier les problèmes liés à vos API en direct et à les résoudre de manière proactive.

Le suivi des performances de l‘API et des mesures d‘utilisation telles que les demandes par minute (RPM), la latence moyenne et maximale, les erreurs par minute, le temps de fonctionnement, l‘utilisation de l‘unité centrale et l‘utilisation de la mémoire fait partie de l‘étape d‘"observation" du cycle de vie de l‘API. Toutes ces données font toujours partie de l‘écosystème de l‘API sans tableau de bord de l‘API. Les données sont toujours accessibles via la passerelle API. Mais pour y accéder, vous devez créer un logiciel personnalisé qui récupère les données de la passerelle.

Un tableau de bord API peut vous aider à suivre, visualiser et analyser les points de données importants pour vous. Il facilite également l‘accès aux mesures de l‘API et les rend plus conviviales. Idéalement, votre tableau de bord devrait obtenir des données en temps réel de la passerelle API.

Prenons l‘exemple dutableau de bord API de Zoho ( plateforme ). Il aide les utilisateurs à suivre leur propre utilisation de l‘API. Bien qu‘il s‘agisse d‘un tableau de bord destiné aux clients, vous pouvez également en utiliser un pour les API internes ou les API externes privées afin de suivre les points de données importants pour vous.

Utilisez Databox pour créer un tableau de bord personnalisé ou créez votre propre tableau de bord.

4. Utiliser des plateformes iPaaS qui prennent en charge la gestion du cycle de vie des API

L‘intégration plateforme en tant que service (iPaaS) permet d‘intégrer l‘ensemble de votre écosystème logiciel afin que les données générées dans votre organisation puissent être sécurisées et préparées pour l‘analyse. Tous les pipelines de données de votre organisation sont automatisés et pilotés par l‘iPaaS plateforme que vous utilisez. Votre stratégie iPaaS englobe tous les actifs numériques, y compris vos API. Au lieu d‘utiliser différents outils pour l‘intégration des applications et la gestion du cycle de vie des API, utilisez une intégration plateforme qui prend en charge les dix étapes du cycle de vie des API.

Vous devrez néanmoins élaborer séparément votre stratégie iPaaS et votre stratégie de gestion du cycle de vie de l‘API. En effet, l‘iPaaS est davantage axé sur l‘automatisation des processus et l‘intégration logicielle, tandis que la gestion du cycle de vie des API se concentre sur la création, l‘utilisation et la maintenance des API. Si votre outil iPaaS prend en charge les deux, vous pourrez gérer les intégrations et la gestion du cycle de vie des API plus efficacement.

Transformez votre gestion du cycle de vie des API avec SnapLogic

SnapLogic est un outil d‘intégration à code faible ou nul plateforme et de gestion d‘API plateforme réunis en un seul et même produit. Vous pouvez créer des pipelines d‘intégration sous forme d‘API REST, importer des spécifications OpenAPI et gérer ces API internes ainsi que des API externes et tierces, le tout sans quitter SnapLogic plateforme. Notre gestion des API plateforme offre une solution complète de gestion du cycle de vie des API qui vous permet d‘accéder à des tableaux de bord d‘API, à un portail de développement d‘API en libre-service et d‘éviter la prolifération d‘outils.

Utilisez notre site plateforme tout-en-un pour contrôler complètement chaque étape du cycle de vie de l‘API, de la planification au retrait. Pour plus d‘informations sur la solution de gestion des API de SnapLogic, cliquez ici.

SnapLogic est le leader de l‘intégration générative.
Catégorie : Intégration SnapLogic
Sujets : API
Gestion du cycle de vie des API : Qu‘est-ce que c‘est et comment le mettre en œuvre ? blog

Nous recrutons !

Découvrez votre prochaine grande opportunité de carrière.