Qu'est-ce qu'un schéma JSON?

Le schéma JSON (JSON Schema) est une norme lexicale basée sur JSON pour décrire la structure et les contraintes des données au format JSON. Il permet de valider, décrire et documenter les données JSON.

Objectifs principaux:

• Validation: Vérifier si une instance JSON respecte une structure définie.
• Documentation: Décrire le format des données JSON.
• Interaction: Échanger des métadonnées entre systèmes.

Composants clés du schéma JSON:

• Types de données: string, number, integer, boolean, object, array, null.
• Mots-clés pour les contraintes:
  • type: Type de donnée attendu.
  • properties: Description des propriétés d’un objet. Chaque propriété a son propre sous-schéma.
  • required: Liste des propriétés obligatoires.
  • items: Description des éléments d’un tableau.
  • minLength/maxLength: Contraintes de longueur pour les chaînes.
  • minimum/maximum: Contraintes pour les nombres.
  • pattern: Expression régulière pour la chaîne.
  • enum: Liste des valeurs autorisées.
  • allOf/anyOf/oneOf/not: Combinaisons logiques de schémas.
• Mots-clés pour les métadonnées:
  • title: Titre court du schéma.
  • description: Description détaillée du schéma.
  • default: Valeur par défaut.

Exemple de schéma JSON:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifiant unique de l’utilisateur"
    },
    "username": {
      "type": "string",
      "minLength": 3
    },
    "isActive": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "id",
    "username"
  ]
}

Exemple de données JSON valides selon ce schéma:

{
  "id": 123,
  "username": "testuser",
  "isActive": false
}

Exemple de données JSON non valides selon ce schéma:

{
  "id": "abc" // Mauvais type
  // Champ obligatoire "username" manquant
}

Utilisation du schéma JSON en QA Automation:

• Validation des réponses API: Vérifier si les réponses JSON respectent le format.
• Validation des requêtes: Vérifier les données JSON entrantes avant traitement.
• Génération de données de test: Utiliser le schéma pour créer des exemples valides (ou non valides).
• Documentation: Créer une documentation API automatiquement maintenue.

Il existe des bibliothèques pour travailler avec les schémas JSON dans différents langages de programmation (par exemple, jsonschema pour Python, json-schema-validator pour Java).