Livraison d'API

Construire, tester et publier des API en utilisant des pipelines de livraison modernes et les meilleures pratiques d’ingénierie.

Résultats

• API mises en œuvre à l’aide de cadres et de modèles testés

Lignes de métro associées

• Ligne de conception de l’API
• Ligne de livraison

Pourquoi c’est important

Même les meilleures conceptions d’API échouent si la livraison est incohérente. Cette station garantit que vos API sont construites avec qualité, testées de manière approfondie et déployées de manière fiable, ce qui permet des itérations plus rapides et une plus grande confiance.

Critères d’entrée

• L’architecture de l’API utilise des modèles qui favorisent la réutilisabilité et l’intégration, et est validée par les parties prenantes.
• L’objectif de l’API est de masquer les modèles de données backend et les divergences.
• La conception et les points de terminaison de l’API ont un lien clair avec leur valeur commerciale et leurs fonctionnalités.
• L’API a une conception cohérente avec nos autres produits API.

Critères de sortie

• L’architecture de l’API utilise des modèles qui favorisent la réutilisabilité et l’intégration, et est validée par les parties prenantes.
• La conception et les points de terminaison de l’API ont un lien clair avec leur valeur commerciale et leurs fonctionnalités.
• L’API et ses points de terminaison sont accompagnés de descriptions qui expliquent leur valeur commerciale et leurs fonctionnalités.
• L’API a une conception cohérente avec nos autres produits API.
• Le contrat API est testé et répond aux exigences fonctionnelles et non fonctionnelles.

Comment cela fonctionne-t-il ?

1. Utiliser des cadres et des bibliothèques établis pour mettre en œuvre les API, en veillant à ce qu’elles soient réutilisables et faciles à entretenir.
   Meilleures pratiques en matière de développement d'API Lignes directrices visant à promouvoir des bases de code API cohérentes et faciles à entretenir, utilisant des bibliothèques standard, des modèles réutilisables et des flux de travail de développement harmonisés.
2. Appliquer des approches de type “contrat d’abord” ou “conception d’abord” pour s’assurer que les contrats d’API sont validés avant leur mise en œuvre.
   Contrat de première conception Une ligne directrice qui préconise des approches "API-first" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.
3. Tester les fonctionnalités, la sécurité et les performances des API à l’aide d’outils de test automatisés.
   Meilleures pratiques de test de l'API Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.
4. Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.
   APIOps CI/CD pour les API Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.
5. S’assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.
   Meilleures pratiques en matière de sécurité des API Un ensemble de contrôles exploitables pour sécuriser les API, y compris l'authentification, l'autorisation, le cryptage, la limitation du débit et les contrôles de conformité au niveau du pipeline.
6. Utilisez la liste de contrôle de l’audit de l’API pour vous assurer que l’API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.
   Liste de contrôle de l'audit de l'API Une liste de contrôle complète pour vérifier l'état de préparation de l'API avant sa publication, couvrant la conception, la documentation, la sécurité et la conformité aux politiques.

Appliquer dans votre travail

Fournir des cadres de codage, des bibliothèques et des normes pour la mise en œuvre des API. Mettre en œuvre des pipelines CI/CD, des cadres d’assurance qualité et des outils d’automatisation du déploiement.