Importer et publier une API
Pour rendre une API disponible via une passerelle d’API, vous devez l’importer et la publier.
Dans l’exemple d’entreprise de ventes de chaussures, NorthWind Shoes veut permettre à des partenaires sélectionnés d’interroger le catalogue et les niveaux des stocks.
Ici, vous apprenez comment importer une API dans Gestion des API Azure et comment rendre une API disponible pour des clients.
API
Une API est une façon standardisée pour les organisations d’exposer des données spécifiques à des développeurs ou des partenaires potentiels. Par exemple, dans l’exercice précédent, vous avez créé une API pour partager des informations sur les produits et les stocks.
Pour rendre une API disponible, vous commencez par l’importer dans Gestion des API. Vous pouvez ensuite :
- Testez votre API en utilisant les outils de visualisation de la passerelle API.
- Gérer l’accès à vos API avec des stratégies.
Frameworks d’API
Il existe différents standards et frameworks d’API. Gestion des API vous offre plusieurs options pour l’importation des API. Y compris les options dans le tableau suivant :
| Type | Détails |
|---|---|
| HTTP | Vous pouvez importer une API HTTP avec une définition d’API vide. Vous spécifiez ensuite manuellement tous les paramètres nécessaires. |
| WebSocket | Configurez le pass-through vers un service WebSocket back-end. |
| GraphQL | Configurez le pass-through vers un service de GraphQL back-end, ou importez un schéma de GraphQL et créez une API GraphQL synthétique avec des résolveurs de champs personnalisés. |
| OpenAPI | OpenAPI est une spécification qui décrit tous les points de terminaison et les opérations des API RESTful, et tous les paramètres d’entrée et de sortie. OpenAPI s’appelait à l’origine Swagger. |
| WADL | WADL (Web Application Description Language) est une description XML des services web basés sur HTTP. C'est un format plus simple et plus léger que le langage de description de service Web. |
| WSDL | WSDL (Web Service Description Language) est une description XML de n’importe quel service réseau, donc pas seulement HTTP. |
Vous pouvez également importer des API à partir de plusieurs ressources Azure back-end. Les options incluent celles du tableau suivant.
| Type | Détails |
|---|---|
| Azure OpenAI Service | API qui donnent accès aux modèles linguistiques d'OpenAI pour des tâches telles que la génération de contenu, le résumé, la recherche sémantique, etc. |
| Application logique | Les applications logiques sont utilisées pour orchestrer et automatiser les workflows et les intégrations avec différentes sources de données. |
| App Service | API hébergée dans un service d’application API dans Azure. |
| Application de fonction | Code serverless qui peut être appelée via des déclencheurs. |
| Application de conteneur | Conteneurs serverless pour les microservices. |
Importer une API
Il existe plusieurs façons d’importer une API dans Gestion des API Azure.
Avec le portail Azure, vous sélectionnez API, puis + Ajouter API. Vous commencez par sélectionner le type d’API que vous souhaitez importer.
Vous fournissez ensuite un lien vers la spécification de votre API sous forme d’URL ou de fichier, et un nom pour l’API. Voici un exemple d’une importation OpenAPI.
Le portail Azure n’est pas l’outil le plus efficace pour l’importation et la configuration d’un grand nombre d’API. À mesure que vous effectuez un scale-up de la gestion des API, vous avez besoin d’outils supplémentaires, comme l’interface Azure CLI, les modèles Azure Resource Manager ou Bicep, ou bien Azure PowerShell. Vous pouvez par exemple utiliser des cmdlets Azure PowerShell pour déployer des passerelles d’API, pour définir et configurer des produits, pour importer des API, ainsi que pour gérer les utilisateurs et les abonnements.
Visualiser
Vous pouvez utiliser la passerelle d’API pour visualiser la façon dont les données sont traitées via vos API importées. Vous pouvez interagir avec des jeux de données et passer des paramètres via vos API.
Si vous êtes administrateur, vous pouvez visualiser les API dans le portail Azure.
Stratégies
Les stratégies offrent des fonctionnalités puissantes pour modifier le comportement d’une API via une configuration. Elles existent sous la forme d’une collection d’instructions qui sont exécutées séquentiellement à la demande ou à la réponse d’une API.
Voici des configurations courantes :
- Conversion de XML en JSON
- Limitation de la fréquence des appels pour restreindre le nombre d’appels entrants.
- Définition d’en-têtes entrants et sortants.
Vous utilisez le portail Azure pour appliquer différentes stratégies aux API. Vous pouvez visualiser les stratégies dans l’onglet Conception.
Vous pouvez également utiliser l’onglet Conception pour ajouter de nouvelles stratégies.
Produit
Un produit est une collection d’API. Vous pouvez affecter des API à plusieurs produits. Par exemple, vous pouvez décider qu’un produit, NorthWindShoesPartners, expose deux API pour vos partenaires :
| Produit | NorthWindShoesPartners |
|---|---|
| API 1 | Catalogue |
| API 2 | Planification |
Pour vos fournisseurs, vous voulez exposer une seule API :
| Produit | NorthWindShoesSuppliers |
|---|---|
| API 1 | Catalogue |
| API 2 |
Vous affectez des stratégies de façon à ce que vos produits puissent avoir différentes règles d’accès, différents quotas d’utilisation et différentes conditions d’utilisation. Ainsi, si vous voulez que vos partenaires et vos fournisseurs aient des droits d’accès différents à votre API Catalogue, affectez l’API à deux produits différents.
Vous utilisez le portail Azure pour associer des API à un produit.
Dans plusieurs niveaux de prix, il existe deux produits par défaut : Starter et Unlimited. Le produit Unlimited est conçu pour la gestion des API en production, car il n’impose aucune restriction sur le nombre d’API attachées. Vous pouvez créer autant de nouveaux produits que nécessaire. Le produit Starter a une limite de cinq appels d’API/minute et un maximum de 100 appels d’API/semaine.