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

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

Selected station: Conception de solution & d'interface

Personnes à impliquer

Ressources associées

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

Voici à quoi ressemble le succès

Fournir des modèles de conception réutilisables, des normes communes et des outils de validation pour les spécifications d'API. S'assurer que les décisions de conception sont cohérentes, examinées dès le début et alignées sur les objectifs métier.

  1. Définir les entités de base, leurs attributs et leurs relations afin de créer une compréhension conceptuelle partagée entre les API. — Domain Canvas
  2. Utilisez le canevas d'interaction pour définir la manière dont les utilisateurs interagiront avec l'API, en veillant à ce qu'elle réponde à leurs besoins et à leurs attentes. — Interaction Canvas
  3. Appliquer les modèles de conception REST pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes. — REST Canvas
  4. Appliquer des modèles de conception orientés événements pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes. — Event Canvas
  5. Appliquer les modèles de conception GraphQL pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
  6. Utiliser les principes de conception et le guide de style des API pour aligner vos décisions de conception sur des règles communes et permettre une validation d'audit cohérente. — Principes de conception de l'API
  7. Appliquez des approches « contract-first » ou « design-first » pour définir et valider le contrat d'interface API avant sa mise en œuvre.
  8. Utilisez la liste de contrôle d'audit des 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é. — Liste de contrôle de l'audit de l'API

Metro lines

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.

Ressources associées

Browse the resources selected for Conception d’API; the summary above explains how they support this station’s work.

Ressources

Resources for Conception d’API

canvas

Interaction Canvas

Dé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.

Résultats

  • Modèle d’interaction défini pour la capacité choisie
  • Entrées, sorties, commandes, requêtes, événements et réponses clarifiés
  • Règles de validation et attentes d’interaction convenues

Comment cela fonctionne-t-il ?

  1. Associer les interactions de l'API aux tâches de l'utilisateur
  2. Définir des points finaux pour chaque interaction
  3. Documentez les entrées et les sorties de chaque interaction.
  4. Spécifier les règles et contraintes de validation
  5. Créer des modèles d'interaction pour les interactions CRUD, axées sur les requêtes, axées sur les commandes et axées sur les événements.

Relevant cycles

Cycle d’automatisation

Cycle pour identifier, concevoir, livrer, enable et améliorer des opportunités d’automatisation.