QuiNon sélectionnéPourquoiNon sélectionnéOùConception d’APICycleCycle de productisation des APILigne de conception de l'API

Station

Conception d’API

Créer des architectures d'API cohérentes, réutilisables et fondées sur les objectifs métier et des normes communes.

La conception d'API ne se limite pas à nommer des points de terminaison. Une bonne conception garantit que les API sont utilisables, cohérentes et alignées sur les objectifs métier et techniques. Une mauvaise conception entraîne un couplage étroit, une faible réutilisation et des retouches coûteuses entre les équipes.

Votre parcours sur la carte

Naviguer dans la méthode

Sélectionnez une station, un cycle ou un point de vue pour explorer la méthode.

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 produit APIExigences utilisateurs & onboarding2Expérience utilisateurAPIArchitecture & décisions de plateforme3Architecture deplateforme APIConception de solution & d'interface4Conception d’APIMise à disposition & opérations5Livraison d’APIAssurance qualité & préparation6Audit APIPublication & enablement7Publication d’APISuivi & amélioration8Suivi & amelioration APILigne des opportunités métierLigne d'architecture de la plateformeLigne de conception de l'APILigne de livraisonLigne Publication & EnablementLigne de modèle opérationnel

Résultats

  • Des conceptions d'API bien documentées et cohérentes
  • Contrats d'interface API réutilisables et validés
  • Conceptions alignées sur les modèles de domaine et les modèles d'interaction
  • Traçabilité de la conception à la valeur métier

Critères du parcours

Critères d'entrée

  • La capacité répond à un besoin métier clair et peut être réutilisée par les utilisateurs prévus.
  • L’interface choisie fournit une abstraction appropriée aux utilisateurs.
  • La proposition de valeur de la capacité a été validée avec les parties prenantes métier et utilisateurs.
  • Les segments d'utilisateurs sont identifiés.
  • Une feuille de route de haut niveau pour la mise en œuvre est définie.

Critères de sortie

  • L'architecture, la plateforme et le mode de mise en œuvre choisis ont été validés avec les parties prenantes concernées en architecture, sécurité et plateforme.
  • L’interface choisie fournit une abstraction appropriée aux utilisateurs.
  • La conception de l'interface et les capacités exposées sont clairement reliées à la valeur métier et aux besoins des utilisateurs.
  • La conception de l'interface respecte les standards partagés de produit, de conception et de qualité.

Personnes à impliquer

Ressources associées

canvasInteraction CanvasDéfinir les interactions API, les flux de travail et les réponses attendues afin de garantir une expérience cohérente pour les consommateurs d'API.canvasREST CanvasConcevoir des API en utilisant les principes RESTful, en définissant des ressources, des verbes et des exemples de requêtes et de réponses.canvasEvent CanvasConcevez des interfaces et intégrations événementielles en définissant les événements, déclencheurs, schémas, producteurs, utilisateurs et logiques de traitement.checklistListe de contrôle de l'audit de l'APIUne 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.guidelinePrincipes de conception de l'APIUn guide concis sur l'ergonomie, la facilité de découverte et la cohérence des API, fondé sur des règles de conception communes et les besoins réels des consommateurs.canvasDomain CanvasUn outil de modélisation pour définir et communiquer les entités et les relations clés de votre domaine, en assurant la cohérence sémantique entre les API.

Lignes de métro

Ligne de conception de l'API

Se concentre sur les principes et les bonnes pratiques de conception des interfaces et des solutions d'intégration.