Fonctionnement de Gestion des API Azure

  • 6 minutes

Ici, nous abordons le fonctionnement de Gestion des API Azure sous trois angles d’utilisation. Ces connaissances contribuent à déterminer si Gestion des API Azure est une bonne solution pour gérer les API de votre organisation.

Dans cette unité, vous découvrez comment fonctionne Gestion des API Azure pour les types d’utilisateurs suivants :

  • Consommateurs d’API
  • Fournisseurs d’API
  • Développeurs d'applications

Fonctionnement de Gestion des API Azure pour les consommateurs d’API

Un consommateur d’API est une entité qui effectue une demande à l’API pour obtenir des données. Par exemple, chacune de ces entités pourrait être un consommateur d’API :

  • Application mobile
  • Application web
  • Appareil IoT

La passerelle est le composant clé de Gestion des API Azure pour les consommateurs. Tous les appels d’API de consommateur sont d’abord routés vers le point de terminaison de votre passerelle. Les consommateurs d’API n’interagissent directement qu’avec la passerelle et jamais avec l’instance de déploiement d’API réelle.

La passerelle effectue de nombreuses tâches du point de vue du consommateur, mais les éléments suivants sont les plus importants :

  • Authentification. La passerelle supervise l’accès à l’API en vérifiant les clés d’abonnement, les jetons JWT et d’autres informations d’identification du consommateur.
  • Sécurité. Cette passerelle empêche toute utilisation abusive de l’API en appliquant des limites de débit et des quotas d’utilisation par le consommateur prédéfinis, ou en validant les demandes et les réponses par rapport au schéma de l’API.
  • Transformation. La passerelle transforme la demande ou la réponse d’API en fonction des besoins. Par exemple, si le service back-end répond avec des données XML, vous pouvez moderniser l’API en transformant automatiquement le XML en JSON, comme illustré dans l’image suivante.
  • Routage. Après l’authentification, la validation et la transformation d’une demande d’API, la passerelle route l’appel vers le service back-end dans lequel l’API est déployée.
  • Performances. La passerelle peut stocker la réponse d’API back-end dans un cache. Dans les situations où la réponse du back-end est statique au fil du temps, le fait de servir les réponses suivantes à partir du cache offre aux consommateurs des temps de réponse plus rapides et réduit la charge sur le serveur back-end.

Une application mobile demande une prévision météorologique avec une API. La passerelle de Gestion des API Azure route l’appel vers le serveur back-end, puis convertit la réponse XML du serveur en JSON avant de la retourner à l’application mobile.

Fonctionnement de Gestion des API Azure pour les fournisseurs d’API

Si vous êtes fournisseur d’API, vous avez toujours beaucoup de travail à effectuer après la publication de vos API. Ce travail comprend les tâches suivantes :

  • Définition des stratégies d’API
  • Gestion des consommateurs d’API
  • Gestion des révisions et des versions d’API
  • Supervision et analyse de vos API

Vous pouvez effectuer toutes ces tâches, et bien plus encore, avec l’interface d’administration de Gestion des API Azure dans le portail Azure. Ou, à l’aide d’outils tels qu’Azure CLI ou Azure PowerShell. Outre vous donner la possibilité de définir des stratégies d’API (comme vous l’avez appris dans l’unité précédente), l’interface d’administration vous permet d’effectuer les tâches suivantes :

  • Définir et importer les spécifications d’API. Importez une spécification OpenAPI, une API REST, une API SOAP (Simple Object Access Protocol) (que vous pouvez éventuellement convertir en REST), une API WebSocket ou une API GraphQL. Vous pouvez également créer une API en important des instances des services Azure suivants : Web Apps, Container Apps, Function App, Logic Apps et Service Fabric. Vous pouvez également créer une API vide et la définir manuellement.
  • Gérer les utilisateurs et les groupes.
    • Un utilisateur est un compte de développeur. Il s’agit d’un compte pour un consommateur d’API. Vous pouvez ajouter manuellement des utilisateurs ou inviter des utilisateurs à créer un compte, mais la plupart des utilisateurs créent leurs propres comptes avec le portail des développeurs.
    • Un groupe est une collection d’utilisateurs associés. Vous pouvez associer un groupe à un produit d’API particulier, afin que chaque utilisateur de ce groupe ait accès au produit dans le portail des développeurs.
  • Empaqueter les API dans les produits. Dans Gestion des API Azure, un produit est un groupe d’API associées. En empaquetant plusieurs API en tant que produit unique, vous pouvez configurer uniquement le produit au lieu de configurer toutes les API séparément. Par exemple, définissez des limites de débit et d’autres stratégies, définissez les conditions d’utilisation, ajoutez des groupes, etc. Cette configuration est appliquée à toutes les API dans le produit. Une fois le produit publié, les consommateurs peuvent s’y abonner et utiliser ses API avec une clé d’abonnement unique.
  • Gérer les révisions et les versions d’API. Quand votre équipe de développeurs d’API doit apporter des modifications à une API, exposez-les de manière sûre et contrôlée sans risque de nuire aux consommateurs en utilisant des révisions et des versions :
    • Une révision est un changement relativement mineur ou non cassant d’une API. Votre équipe de développement peut programmer et tester la révision séparément de l’API de production, comme l’illustre l’image suivante. Ensuite, quand votre révision est prête pour les consommateurs, utilisez l’interface d’administration de Gestion des API Azure pour définir l’API mise à jour en tant que révision actuelle.
    • Une version est un changement relativement important ou cassant d’une API. Gestion des API Azure vous permet d’offrir aux développeurs plusieurs versions de l’API simultanément. Il offre également plusieurs schémas de versioning, notamment le versioning basé sur les chemins, sur les en-têtes et sur les chaînes de requête.
  • Superviser et analyser les API. L’interface d’administration comprend des outils de supervision intégrés pour suivre et examiner le trafic d’API en temps réel ainsi que des analytiques pour obtenir des insights sur la façon dont les consommateurs utilisent vos API publiées. Gestion des API Azure prend également en charge plusieurs outils Azure pour la supervision des API et l’exécution des charges de travail analytiques. Les services Azure pris en charge par Gestion des API Azure incluent les journaux Azure Monitor, Application Insights et Event Hubs.

Description du fonctionnement des révisions dans Gestion des API Azure. Les demandes d’API des consommateurs sont routées vers la révision actuelle de l’API, tandis que les demandes d’API de l’équipe de développement interne sont routées vers la révision de l’API.

Fonctionnement de Gestion des API Azure pour les développeurs d’application

Sauf dans le cas du niveau Consommation, toutes les instances de Gestion des API Azure incluent un portail des développeurs dans lequel vous exposez vos API aux consommateurs d’API potentiels et existants. Le portail des développeurs est doté d’une interface par défaut que vous pouvez personnaliser en fonction des exigences de votre organisation et de son identité.

Les développeurs d’applications qui ont des comptes de développeurs se connectent au portail des développeurs (qui accepte également les utilisateurs invités qui n’ont pas encore de compte). Les développeurs se voient ensuite présenter une interface web qui leur permet d’interagir avec les API des manières suivantes :

  • Accès à la documentation des API. Les développeurs peuvent consulter la documentation que vous avez fournie pour chaque API.
  • Test d’une API. Le portail des développeurs offre une console interactive qui permet à un développeur de tester une API rapidement et de manière sécurisée. Le développeur peut choisir une opération d’API, ajouter des valeurs de paramètre, puis envoyer l’appel pour déterminer la réponse retournée par l’API.
  • Consultation d’exemples de code d’API. Le portail des développeurs propose des exemples d’appels d’API dans plusieurs langages de programmation, notamment C#, Java, JavaScript, PHP et Python.
  • Abonnement à une API. Quand un consommateur décide d’utiliser votre API, il peut recourir au portail des développeurs pour créer un abonnement à l’API et obtenir une clé d’abonnement à utiliser pour appeler l’API.
  • Exécution d’analytiques. Le portail des développeurs offre des analytiques sur l’utilisation d’une API par le développeur.