Cluster C1 : Écosystème JSON
Checklist de validation JSON Schema
Avant de publier une évolution d'API ou de configuration, cette checklist aide à aligner champs requis, exemples et contrôles de régression autour de JSON Schema.
Fixer le contrat avant le code
Le rôle d'un schema n'est pas seulement de faire passer un validateur. Il sert aussi à aligner l'équipe sur les champs requis, les valeurs nulles autorisées et les enums.
Quand la documentation, les exemples et les règles réelles divergent, les incidents apparaissent souvent en intégration ou juste avant la mise en ligne.
Points à vérifier avant livraison
- required, type, enum et format doivent refléter les vraies contraintes de l'API.
- Préparez au moins un exemple valide et un exemple invalide pour les objets imbriqués et les tableaux.
- Ajoutez la validation Schema au CI pour éviter les régressions silencieuses.
Exemple pratique entrée/sortie
Entrée
{
"type": "object",
"required": ["id", "status"],
"properties": {
"id": { "type": "string" },
"status": { "enum": ["ready", "failed"] }
}
}Sortie
Résultat : - échec si payload.id manque - payload.status doit être ready ou failed