Station

Conception des contrats - Définir des contrats API clairs

Créer des contrats d'interface clairs et bien définis qui décrivent les attentes, les responsabilités et les directives d'utilisation.

Les contrats d'interface sont essentiels pour garantir la clarté et l'alignement entre les fournisseurs d'API et les utilisateurs. Cette station fournit des lignes directrices pour la conception de contrats d'interface clairs, complets et faciles à comprendre.

Votre parcours sur la carte

Plan de métro

Select a cycle, station, or stakeholder to open its permanent method page.

StratégiqueGouvernanceConsommateurTechniqueExpérience utilisateurExpérience utilisateurAperçus du marchéAperçus du marchéObjectifs de l'entrepriseObjectifs de l'entrepriseAnalyse concurrentielleAnalyse concurrentielleVision de l'écosystèmeVision de l'écosystèmeInfrastructure évolutiveInfrastructure évolutiveJuridique et conformitéJuridique et conformitéSécurité et confidentialitéSécurité et confidentialitéNormes de conceptionNormes de conceptionGestion des fournisseursGestion des fournisseursConception des contratsConception des contratsDéveloppementDéveloppementCI/CDCI/CDAutomatisation des testsAutomatisation des testsGestion des versionsGestion des versionsAccords de serviceAccords de serviceAdoption de l'API par les utilisateursAdoption de l'API par les utilisateursPromotion de l'APIPromotion de l'APIIntégration des partenairesIntégration des partenairesL'état d'esprit de l'APIL'état d'esprit de l'APIRôles et responsabilitésRôles et responsabilitésUpkillingUpkillingLignes directrices opérationnellesLignes directrices opérationnellesGestion de portefeuilleGestion de portefeuilleGestion du budget et des ressourcesGestion du budget et des ressourcesStratégie de capacité1Stratégie de capacitéExigences utilisateurs & onboarding2Exigences utilisateurs &onboardingArchitecture & décisions de plateforme3Architecture & décisionsde plateformeConception de solution & d'interface4Conception de solution &d’interfaceMise à disposition & opérations5Mise à disposition &opérationsAssurance qualité & préparation6Assurance qualité &préparationPublication & enablement7Publication & enablementSuivi & amélioration8Suivi & améliorationLigne des opportunités métierLigne d'architecture de la plateformeLigne de conception de l'APILigne de livraisonLigne Publication & EnablementLigne de modèle opérationnel

Selected station: Conception des contrats - Définir des contrats API clairs

Personnes à impliquer

Ressources associées

Résultats

  • Contrats d'interface clairs définis pour chaque API
  • Attentes et responsabilités des fournisseurs d'API et des utilisateurs
  • Directives d'utilisation et bonnes pratiques documentées
  • Réduction des malentendus et des litiges concernant l'utilisation de l'API

Critères du parcours

Critères d'entrée

Critères de sortie

Voici à quoi ressemble le succès

Fournir des modèles de conception de contrats, des formats normalisés et des processus d'examen. Veiller à ce que les équipes créent des contrats d'interface clairs et bien définis qui décrivent les attentes, les responsabilités et les directives d'utilisation.

  1. Définir des contrats d'interface qui décrivent les attentes, les responsabilités et les directives d'utilisation pour chaque API.
  2. Utiliser des formats normalisés (par exemple, OpenAPI, AsyncAPI) pour créer des contrats d'interface lisibles par machine, faciles à partager et à valider.
  3. Veiller à ce que les contrats API soient examinés et approuvés par les parties prenantes afin de garantir l'alignement et la clarté. — Liste de contrôle de l'audit de l'API

Metro lines

Ligne de livraison

Couvre les pratiques de mise en œuvre, de test, d'automatisation et de livraison.

Ressources associées

Browse the resources selected for Conception des contrats - Définir des contrats API clairs; the summary above explains how they support this station’s work.

Ressources

Resources for Conception des contrats - Définir des contrats API clairs

checklist

Liste de contrôle de l'audit de l'API

Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.

Résultats

  • Compréhension partagée de l’objectif et de l’utilisation de « Liste de contrôle de l'audit de l'API »
  • Approche cohérente pour appliquer « Liste de contrôle de l'audit de l'API »
  • Meilleure application des pratiques associées

Comment cela fonctionne-t-il ?

  1. Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que la conception de l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.
  2. Réalisez des audits pour évaluer la couverture du cycle de vie et vérifier que l'API respecte les normes métier, de conception et opérationnelles.
  3. S'assurer que la documentation, les modèles de sécurité, la configuration de la passerelle et les exigences légales sont clairement définis, validés et étayés par des preuves.

Relevant cycles