Station

Normes de conception - Garantir une conception cohérente et de haute qualité de l'API

Établir des normes et des lignes directrices en matière de conception afin de garantir une conception cohérente et de haute qualité de l'API dans l'ensemble de l'organisation.

Une conception cohérente et de haute qualité des API est essentielle pour la convivialité, la maintenabilité et l'évolutivité. Cette station fournit des normes de conception et des lignes directrices qui aident les équipes à créer des API faciles à utiliser, à comprendre et à maintenir.

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: Normes de conception - Garantir une conception cohérente et de haute qualité de l'API

Personnes à impliquer

Ressources associées

Résultats

  • Conception cohérente de l'API dans l'ensemble de l'organisation
  • Des API de haute qualité qui répondent aux besoins des utilisateurs
  • Modèles et composants de conception réutilisables
  • Réduction des incohérences de conception et de la dette technique

Critères du parcours

Critères d'entrée

Critères de sortie

Voici à quoi ressemble le succès

Fournir une documentation sur les normes de conception, les composants réutilisables et les processus de révision de la conception. Veiller à ce que les équipes respectent les normes de conception et procèdent à des révisions régulières afin de maintenir une conception d'API de haute qualité.

  1. Définir des normes et des lignes directrices pour la conception des API, y compris les conventions de dénomination, les formats de réponse et la gestion des erreurs. — Principes de conception de l'API
  2. Créer des modèles de conception et des composants réutilisables que les équipes peuvent exploiter pour garantir la cohérence et la qualité.
  3. Procéder à des examens et à des audits de la conception afin de garantir le respect des normes de conception et d'identifier les domaines susceptibles d'être améliorés. — Liste de contrôle de l'audit de l'API

Metro lines

Ressources associées

Browse the resources selected for Normes de conception - Garantir une conception cohérente et de haute qualité de l'API; the summary above explains how they support this station’s work.

Ressources

Resources for Normes de conception - Garantir une conception cohérente et de haute qualité de l'API

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