Des conceptions d'API bien documentées et cohérentes
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.
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.
Étape1/8
Un 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.
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.
Étape2/8
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.
Utilisez le canevas d'interaction pour définir la manière dont les consommateurs interagiront avec l'API, en veillant à ce qu'elle réponde à leurs besoins et à leurs attentes.
Étape3/8
Concevoir des API en utilisant les principes RESTful, en définissant des ressources, des verbes et des exemples de requêtes et de réponses.
Appliquer les modèles de conception REST pour créer des contrats d'API cohérents et réutilisables qui sont validés avec les parties prenantes.
Étape4/8
Concevoir des API pilotées par les événements en définissant les événements, les déclencheurs et la logique de traitement.
Appliquer des modèles de conception orientés événements pour créer des contrats d'API cohérents et réutilisables qui sont validés avec les parties prenantes.
Étape5/8
Concevoir des API GraphQL en définissant des types, des requêtes, des mutations et des abonnements.
Appliquer les modèles de conception GraphQL pour créer des contrats d'API cohérents et réutilisables qui sont validés avec les parties prenantes.
Étape6/8
Un 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.
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.
Étape7/8
Une ligne directrice qui préconise des approches "API-first" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.
Appliquez des approches « contract-first » ou « design-first » pour définir et valider le contrat de l'API avant sa mise en œuvre.
Étape8/8
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.
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é.
