Note
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de changer d’annuaire.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de changer d’annuaire.
Explorez les concepts clés du Centre d’API Azure, qui vous permettent de suivre les API dans un emplacement centralisé pour la découverte, la réutilisation et la gouvernance.
Modèle de données
Les principales entités d’une configuration du Centre des API Azure incluent vos API et leurs versions, définitions et déploiements. Les environnements d’exécution possibles pour chaque API et métadonnées descriptives complètent la configuration.
Le diagramme suivant montre les principales entités et la façon dont elles se rapportent les unes aux autres.
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.
Vous pouvez gérer une API dans l’inventaire par n’importe quelle solution de gestion des API. Par exemple, utilisez Gestion des API Azure, Gestion des API Apigee, Kong Konnect, MuleSoft API Management ou une autre plateforme. Une API représentée dans le Centre d’API Azure peut également être non gérée.
Les gestionnaires de programmes d’API ou les administrateurs informatiques peuvent créer et gérer l’inventaire des API dans le Centre des API Azure. Le Centre API d’Azure inclut également des fonctionnalités permettant aux développeurs d’API d’inscrire des définitions d’API directement depuis leurs environnements de développement, comme Visual Studio Code ou des pipelines CI/CD.
Version de l'API
Le contrôle de version d’API est la pratique de la gestion des modifications apportées à une API et de s’assurer que les modifications sont apportées sans perturber 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 importantes, tandis que d'autres apportent des améliorations mineures. Une version d’API peut être à n’importe quelle étape du cycle de vie : de la conception, à la préversion, à la production ou à l'obsolescence.
Définition API
Il doit y avoir au moins une définition pour chaque version de l’API, 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.
Pour faciliter la gouvernance des API, le Centre API d’Azure fournit des fonctionnalités de linting pour analyser la qualité et la conformité des définitions d’API relativement aux standards de l’organisation.
Environment
Un environnement représente un emplacement où un runtime d’API est déployable, tel qu’un service Gestion des API Azure ou un service Gestion des API Apigee. Vous pouvez également déployer sur un service de calcul comme un cluster Kubernetes, une application web ou une application Azure Functions. 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 des API Azure pour suivre l’un de vos environnements d’exécution d’API, qu’ils soient hébergés 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 des API Azure, organisez vos API, déploiements et autres entités en définissant des valeurs de métadonnées. Les métadonnées sont utiles pour rechercher et filtrer et appliquer des normes de gouvernance. Un centre d’API fournit plusieurs propriétés de métadonnées intégrées courantes telles que API type et lifecycle stage. 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 API approver propriété de métadonnées pour identifier l’individu 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.