Qu’est-ce qu’Azure API Center ?
Azure API Center est un nouveau service sur Azure qui offre un référentiel structuré et centralisé de toutes vos API organisationnelles, ce qui permet le suivi unifié, la découverte, la réutilisation et la gouvernance. Le Centre d’API est une solution sécurisée qui consolide et organise toutes vos API, quel que soit leur type, l’étape du cycle de vie de développement dans laquelle elle se trouve ou leur emplacement de déploiement pour votre runtime d’API, ainsi que toutes les métadonnées ou informations relatives à l’API.
Avantages du Centre d’API
| Problème du client | Avantages du Centre d’API |
|---|---|
| Mauvaise détectabilité et réutilisation des API | Facilité avec laquelle des API sont détectées et consommées. Les gestionnaires d’API peuvent consulter un inventaire complet de toutes les API dans le portail Microsoft Azure. Les consommateurs d’API peuvent utiliser le portail web du Centre d’API pour découvrir et consommer des API, ou utiliser l’extension du Centre d’API pour Visual Studio Code afin de générer, découvrir et consommer des API. |
| Clichés instantanés, API non gouvernementales | Inventaire centralisé des API. Le Centre d’API permet aux organisations de créer un référentiel central d’API provenant de différentes équipes et services qui agissent comme une source consolidée de vérité et de confiance pour toutes les API. |
| Menaces de sécurité potentielles | Facilité de gouvernance des API. Étant donné que les API sont consolidées dans un seul et même emplacement, la gouvernance de ces API pour appliquer des stratégies de sécurité d’organisation devient plus facile pour les équipes de la plateforme d’API. |
| Conception incohérente de l’API | Vérifications de conformité de conception d’API automatisées. Le Centre d’API permet aux administrateurs d’appliquer des normes de conception à toutes les API et d’implémenter un flux de travail de linting qui vérifie les API par rapport à un guide de style défini et génère un rapport de conformité d’API accessible dans votre Centre d’API. |
Rôles et responsabilités dans l’écosystème d’API
L’écosystème d’API d’une organisation se compose souvent de rôles différents avec diverses responsabilités qui font partie intégrante de son bon fonctionnement. Examinons de plus près certains des rôles.
Producteurs d’API - Il peut s’agir de développeurs individuels ou d’équipes dont les principales responsabilités sont les suivantes :
- Consolidation des spécifications et des exigences du système
- Conception de l’architecture d’API qui correspond aux objectifs définis
- Développement, sécurisation et publication des API
- Tester et garantir que les API répondent aux exigences en matière de fonctionnement et de performance
- Documentation des API
- Opérations de maintenance des API, qui incluent la gestion des versions et des mises à jour
Les producteurs d’API mettent tout en œuvre pour suivre les meilleures pratiques, les stratégies de sécurité et de conformité ainsi que les normes d’API organisationnelles pour assurer une certaine cohérence. Ils doivent également veiller à ne pas faire double emploi avec le travail de précédentes/ autres équipes au sein de l’organisation.
Consommateurs d’API - Il peut s’agir d’utilisateurs internes ou externes des API qui :
- Consommer des API privées dans leurs flux de travail et services d’entreprise internes (consommateurs internes)
- Utiliser des points de terminaison d’API restreints pour s’intégrer à des partenariats commerciaux stratégiques (consommateurs partenaires)
- Consommer des API disponibles publiquement pour générer des systèmes externes qui utilisent des services fournis par l’organisation (consommateurs tiers)
Les consommateurs d’API doivent s’assurer de découvrir rapidement les API les plus appropriées pour leurs charges de travail afin d’éviter de gaspiller des ressources de développement précieuses et des efforts sur les duplications. Pour ce faire, il est important qu’ils reçoivent une documentation de qualité et facile à utiliser pour valider que les API répondent aux besoins respectifs et qu’elles peuvent s’intégrer en toute transparence à leurs applications.
Équipe de la plateforme d’API : les ingénieurs de la plateforme d’API sont ne charge de créer et de maintenir les architectures d’API évolutives, sécurisées et hautement performantes pour leur organisation. Certaines de leurs tâches sont les suivantes :
- Conception et développement de l’architecture d’API
- Établir et appliquer les meilleures pratiques d’API et les normes de conception au sein de l’organisation
- Appliquer la surveillance, l’analyse et la création de rapports pour générer des insights actionnables
- Implémenter et gérer la sécurité des API par le biais des protocoles d’authentification, d’autorisation et de chiffrement
- Faciliter la collaboration et les commentaires entre les responsables de produits, les producteurs d’API et les consommateurs pour s’aligner sur les stratégies d’API
- Aider à l’intégration des API et résoudre les problèmes en interne et en externe
Les ingénieurs de la plateforme d’API de Contoso collaborent pour déployer une stratégie facile à adopter qui empêchera l’organisation de rencontrer une prolifération d’API.
Fonctionnement du Centre d’API
Dans une organisation, les ingénieurs de la plateforme d’API ont besoin de pouvoir configurer rapidement et facilement un référentiel centralisé reprenant toutes leurs API (internes et externes) ainsi que d’autres métadonnées telles que les versions d’API, les définitions, etc. Avec le Centre d’API, vous pouvez créer un catalogue des API hébergées et gérées sur différentes solutions de gestion des API et les gérer dans leurs différents cycles de vie de conception, de développement, de test et de production.
Fonctionnalités du Centre d’API Azure
Inventaire des API
La base du Centre d’API consiste à créer un inventaire complet et à jour de toutes les API développées et utilisées dans toute l’organisation. Cet inventaire est essentiel pour la gouvernance, la découverte et la consommation des API à grande échelle.
Avec le Centre d’API, vous pouvez ajouter des API à votre inventaire, peu importe :
- la technologie et le langage de l’API : API web ASP.NET Core, Express, FastAPI, API serverless, etc.
- le type d’API : REST, GraphQL, SOAP, gRPC, WebSocket, WebHook, etc.
- l’environnement d'exécution : cluster Kubernetes, application web, gestion des API, gestion des API Apigee, Azure Functions, etc.
Gouvernance des API
Maintenant que nous disposons d’un inventaire complet des API, nous devons voir comment nous pouvons nous assurer que ces API sont cohérentes, normalisées, utilisables et sécurisées. La gouvernance des API est définie comme la pratique de déterminer et d’appliquer des normes, des stratégies et des processus à grande échelle sur toutes les API organisationnelles.
Au niveau du Centre d’API, cette fonctionnalité simplifie le suivi des API à l’aide de métadonnées telles que les versions, les propriétaires, le cycle de vie et le suivi des processus tels que les révisions de conformité, la détection des changements cassants, etc.
Le Centre d’API offre également des outils en matière de gouvernance de la conception d’API qui prennent en charge le linting, implémenté à l’aide d’un linter spectral JSON/YAML, qui garantit que les API inscrites sont conformes aux règles de style de l’organisation et fournit une fonction analytique pour vos API. L’activation de ces outils permet à votre organisation de détecter rapidement les erreurs et les incohérences en générant un rapport de conformité qui peut être consulté dans votre Centre d’API.
Les efforts de la plateforme d’API sont les plus fructueux lorsque les développeurs y adhèrent. L’extension du Centre d’API pour Visual Studio Code fournit des fonctionnalités de gouvernance des API décalées à gauche pour la détection des changements cassants et la gouvernance de la conception des API afin de garantir que les API sont conçues correctement dès la première tentative.
Découverte et consommation d’API
Le Centre d’API rationalise l’ensemble du cycle de vie du développement des API, ce qui améliore l’expérience des développeurs en s’intégrant à des outils de développement populaires tels que Visual Studio Code. L’extension du Centre d’API offre aux consommateurs d’API une expérience de découverte, d’essai et de consommation des API directement dans Visual Studio Code, dans le contexte dans lequel ils travaillent déjà. Une autre fonctionnalité du Centre d’API est un portail web traditionnel du Centre d’API, conçu pour permettre aux consommateurs d’API de naviguer facilement dans la documentation, de découvrir, d’accéder et d’utiliser des API à partir de votre catalogue d’API.
Dans la leçon suivante, vous verrez comment créer et gérer votre inventaire d’API avec le Centre d’API via le portail Microsoft Azure, localement à l’aide de l’interface de ligne de commande Azure ou sur Visual Studio Code à l’aide de l’extension du Centre d’API.