Conception cohérente de l'API dans l'ensemble de l'organisation
É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.
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é.
Étape1/3
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.
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.
Étape2/3
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é.
Étape3/3
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.
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.
