Conception d'API

Créer des conceptions d’API réfléchies qui s’alignent sur les besoins des utilisateurs, les objectifs du produit et les spécifications cohérentes.

Résultats

• Des conceptions d’API bien documentées et cohérentes

Métrolines connexes

• Ligne de conception de l’API

Pourquoi c’est important

Concevoir des API ne consiste pas seulement à nommer des points d’extrémité. Une bonne conception garantit que les API sont utilisables, cohérentes et alignées sur les objectifs commerciaux et techniques. Des API mal conçues entraînent une dette technique, une adoption médiocre et des remaniements au sein des équipes.

Critères d’entrée

• L’architecture de l’API utilise des modèles qui favorisent la réutilisabilité et l’intégration, et est validée par les parties prenantes.
• L’objectif de l’API est de masquer les modèles de données backend et les divergences.
• La conception et les points de terminaison de l’API ont un lien clair avec leur valeur commerciale et leurs fonctionnalités.
• L’API a une conception cohérente avec nos autres produits API.

Critères de sortie

• L’architecture de l’API utilise des modèles qui favorisent la réutilisabilité et l’intégration, et est validée par les parties prenantes.
• L’objectif de l’API est de masquer les modèles de données backend et les divergences.
• La conception et les points de terminaison de l’API ont un lien clair avec leur valeur commerciale et leurs fonctionnalités.
• L’API a une conception cohérente avec nos autres produits API.

Comment cela fonctionne-t-il ?

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 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.
2. 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.
   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.
3. 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.
   REST Canvas 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.
4. 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.
   Event Canvas Concevoir des API pilotées par les événements en définissant les événements, les déclencheurs et la logique de traitement.
5. 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.
   GraphQL Canvas Concevoir des API GraphQL en définissant des types, des requêtes, des mutations et des abonnements.
6. Utiliser les connaissances acquises pour concevoir des API qui répondent aux besoins des consommateurs, en veillant à ce qu’elles soient découvrables, compréhensibles et utilisables.
   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.
7. 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é.
   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 des modèles réutilisables, des normes et des outils de validation pour les spécifications de l’API. Veiller à ce que les équipes suivent les revues de conception et intègrent rapidement le retour d’information.