Centre API Azure : les concepts clés
Cet article explique les concepts clés du Centre d’API Azure. Le Centre d’API Azure est un emplacement centralisé qui permet de suivre les API (découverte, réutilisation et gouvernance).
Modèle de données
Le diagramme suivant montre les principales entités du Centre d’API Azure et comment elles sont liées les unes aux autres. Pour plus d’informations sur ces entités et les concepts associés, consultez les sections suivantes.
API
Entité logique de niveau supérieur dans le Centre d’API Azure : une API représente toutes les API réelles que vous voulez suivre. Un centre d’API peut inclure des API de tous les types, y compris REST, GraphQL, gRPC, SOAP, WebSocket et Webhook.
Une API peut être gérée par n’importe quelle solution de gestion des API (comme Azure Gestion des API ou des solutions d’autres fournisseurs) ou non gérée.
L’inventaire d’API dans le Centre d’API Azure est conçu pour être créé et géré par des chefs de programme d’API ou des administrateurs informatiques.
Version de l'API
Le contrôle de version d’API permet de gérer les modifications apportées à une API et de s’assurer que celles-ci ne perturbent pas les clients. Une API peut avoir plusieurs versions au cours des phases de cycle de vie, chacune étant alignée sur des modifications d’API spécifiques. Certaines versions peuvent introduire des modifications majeures ou des changements cassants, tandis que d’autres ajoutent des améliorations mineures. Une version d’API peut survenir à n’importe quelle étape du cycle de vie : de la conception, à la préversion, à la production ou à l’obsolescence.
Définition API
Chaque version de l’API doit idéalement être déterminée par au moins une définition, telle qu’une définition OpenAPI pour une API REST. Le Centre d’API Azure autorise tous les fichiers de définition d’API au format texte (YAML, JSON, Markdown, etc.). Vous pouvez, entre autres, charger des définitions OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL et WADL.
Environnement
Un environnement représente un emplacement où un runtime d’API peut être déployé. Par exemple, un service Gestion des API Azure, un service Gestion des API Apigee ou un service de calcul tel qu’un cluster Kubernetes, une application web ou une fonction Azure. Chaque environnement est aligné sur une étape du cycle de vie, comme le développement, les tests, la préproduction ou la production. Un environnement peut également inclure des informations sur le portail des développeurs ou les interfaces de gestion.
Remarque
Utilisez le Centre d’API Azure pour suivre vos environnements d’exécution d’API, qu’ils soient hébergés ou non sur l’infrastructure Azure. Ces environnements ne sont pas les mêmes que les environnements de déploiement Azure.
Déploiement
Un déploiement est un emplacement (une adresse) où les utilisateurs peuvent accéder à une API. Une API peut avoir plusieurs déploiements, tels que dans différents environnements ou régions intermédiaires. Par exemple, une API peut avoir un déploiement dans un environnement de préproduction interne et un autre dans un environnement de production. Chaque déploiement est associé à une définition d’API spécifique.
Métadonnées
Dans le Centre d’API Azure, organisez vos API, vos déploiements et d’autres entités en définissant des valeurs de métadonnées que vous pouvez utiliser pour la recherche et le filtrage, et pour appliquer des standard de gouvernance. Un centre d’API fournit plusieurs propriétés de métadonnées intégrées courantes comme « Type d’API » et « Étape de cycle de vie ». Le propriétaire d’un centre d’API peut augmenter les métadonnées intégrées en définissant des métadonnées personnalisées dans un schéma de métadonnées pour organiser ses API, ses déploiements et ses environnements. Par exemple, créez une propriété approbateur d’API pour identifier la personne responsable de l’approbation d’une API à utiliser.
Le Centre d’API Azure prend en charge les métadonnées personnalisées de type tableau, booléen, nombre, objet, choix prédéfinis et chaîne.
Le schéma de métadonnées du Centre d’API Azure est compatible avec les spécifications de schéma JSON et YAML, pour autoriser la validation de schéma dans les outils de développement et les pipelines automatisés.