Contrat de première conception

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.

Résultats

• Meilleure compréhension des principes de conception du contrat d’abord

Comment cela fonctionne-t-il ?

Étapes

1. Appliquer des approches de type “contrat d’abord” ou “conception d’abord” pour s’assurer que les contrats d’API sont validés avant leur mise en œuvre.
2. Définir des contrats d’API qui décrivent les attentes, les responsabilités et les directives d’utilisation pour chaque API.
3. Utiliser des formats normalisés (par exemple, OpenAPI, AsyncAPI) pour créer des contrats d’API lisibles par machine, faciles à partager et à valider.

Astuce

• Personnalisez le Contract First Design pour votre domaine
• L’utiliser en collaboration avec les entreprises et les techniciens