Normes de conception

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

Résultats

• Conception cohérente de l’API dans l’ensemble de l’organisation

Métrolines connexes

• Ligne d’architecture de la plate-forme

Pourquoi c’est important

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.

Comment cela fonctionne-t-il ?

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 Un guide concis sur l'utilisabilité, la découvrabilité et la cohérence des API, fondé sur des philosophies de conception éprouvées et sur les besoins des utilisateurs.
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 Une liste de contrôle complète pour vérifier l'état de préparation de l'API avant sa publication, couvrant la conception, la documentation, la sécurité et la conformité aux politiques.

Appliquer dans votre travail

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