Utilisez JSON Schema pour documenter des contrats d’API, valider des payloads JSON et générer des données mock réalistes pour les tests et démos.
Étape 1 – Partir d’un exemple réel
- Collez une vraie réponse d’API, un payload de requête ou un JSON de config dans le formateur d’abord.
- Gardez un exemple JSON canonique par endpoint pour éviter la dérive du schéma.
Étape 2 – Générer un schéma de base
- Utilisez le Générateur de Schema pour inférer les types, champs requis et structure imbriquée.
- Affinez descriptions, formats et contraintes (min/max, patterns) avant la production.
Étape 3 – Valider le JSON avec le schéma
- Collez votre schéma et des payloads réels dans le Validateur de Schema.
- Corrigez en ajustant soit l’exemple JSON (bug), soit le schéma (changement de contrat).
Étape 4 – Générer des données mock pour tester
- Ouvrez le Générateur de Mock pour créer des payloads réalistes qui respectent votre schéma.
- Utilisez seed + batch size pour rendre les données reproductibles et scalables.
Étape 5 – Partager et réutiliser
- Versionnez vos schémas et liez-les à vos docs d’API.
- Générez du code typé (TypeScript/Java/etc.) depuis des exemples JSON stables.
Note importante sur les fonctionnalités JSON Schema
- Certains schémas s’appuient sur des mots-clés avancés comme
$ref, anyOf, oneOf, et allOf. - Le support des drafts et des mots-clés varie selon les validateurs ; pour une conformité stricte, utilisez un validateur JSON Schema complet en CI.
Exemple : JSON → JSON Schema (simplifié)
// JSON input
{
"id": 1,
"name": "Maeve Winters",
"active": true,
"tags": ["developer", "backend"]
}
// Generated schema (example)
{
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" },
"active": { "type": "boolean" },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "name", "active", "tags"]
}