Audit API

Valider que les API répondent aux normes organisationnelles, techniques et juridiques avant de les publier.

Résultats

• Les API sont conformes aux normes internes et externes

Lignes de métro associées

• Ligne de conception de l’API
• Ligne d’édition et d’adoption

Pourquoi c’est important

Les API sont des produits à longue durée de vie et doivent répondre aux attentes en matière de qualité, de cohérence et de conformité. Les audits réduisent les risques, empêchent les défauts d’atteindre la production et soutiennent les certifications externes.

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.
• 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.

Critères de sortie

• L’API passe avec succès les contrôles de conformité, de sécurité et d’audit.
• Les rapports d’audit sont partagés avec les parties prenantes.
• L’API est prête à être publiée sur les passerelles et dans les environnements appropriés afin de permettre sa réutilisation par plusieurs consommateurs d’API.
• La documentation de l’API est complète et prête à être publiée.

Comment cela fonctionne-t-il ?

1. Mener des audits pour s’assurer que les API respectent les normes organisationnelles, techniques et juridiques avant d’être publiées.
   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.
2. Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.
   Meilleures pratiques en matière de conformité de l'API Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.
3. Collaborer avec les équipes de gouvernance et les experts du domaine pour s’assurer que les API sont prêtes pour la production.

Appliquer dans votre travail

Créer des cadres et des outils de gouvernance pour valider la conformité, les performances et la sécurité des API. Vérifier que les API répondent aux critères de validation.