Explorer
KNOW-PAT-254

Contrat d'API HTTP explicite, versionné et testable

Domaine
architecture
Type
pattern
Priorité
P1

Contrat d'API HTTP versionné

Le contrat est la frontière stable entre producteurs et consommateurs. Il décrit ce que l'API garantit ; il ne doit pas être généré après coup à partir d'un comportement non maîtrisé.

Séquence

  1. Modéliser ressources, identités et transitions métier.
  2. Choisir la sémantique HTTP appropriée et documenter idempotence et cache.
  3. Définir schémas et erreurs avant d'implémenter les handlers.
  4. Valider automatiquement le contrat et tester sa compatibilité.
  5. Versionner seulement lorsqu'une évolution compatible est impossible.