Validation du schéma JSON avant les appels d'API

Validation de schéma JSON Avant les Appels API

La validation de schéma JSON est un contrat qui définit la structure, les types et les contraintes d'un document JSON. Validez les payloads avant de les envoyer à une API, et vous attrapez les erreurs côté client au lieu de déboguer des réponses 400 cryptiques.

Quel Ressemble un Schéma JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    },
    "age": {
      "type": "integer",
      "minimum": 0,
      "maximum": 150
    },
    "role": {
      "type": "string",
      "enum": ["admin", "user", "viewer"]
    }
  },
  "required": ["email", "role"]
}

Ce schéma impose : email doit être une chaîne de caractères valide, age doit être un entier compris entre 0 et 150, role doit être l'un des trois valeurs, et les deux champs email et role sont obligatoires.

Pourquoi Valider Avant d'Envoyer

Validation en JavaScript (ajv)

import Ajv from 'ajv';
import addFormats from 'ajv-formats';

const ajv = new Ajv();
addFormats(ajv); // ajoute "email", "uri", "date-time", etc.

const schema = {
  type: 'object',
  properties: {
    email: { type: 'string', format: 'email' },
    role:  { type: 'string', enum: ['admin', 'user', 'viewer'] }
  },
  required: ['email', 'role']
};

const validate = ajv.compile(schema);

const payload = { email: 'not-an-email', role: 'superadmin' };
if (!validate(payload)) {
  console.error(validate.errors);
  // [{keyword: 'format', message: 'must match format "email"'}, ...]
}

Validation en Python (jsonschema)

from jsonschema import validate, ValidationError

schema = {
    "type": "object",
    "properties": {
        "email": {"type": "string", "format": "email"},
        "role":  {"type": "string", "enum": ["admin", "user", "viewer"]}
    },
    "required": ["email", "role"]
}

try:
    validate(instance={"email": "[email protected]"}, schema=schema)
except ValidationError as e:
    print(e.message)  # 'role' est un champ obligatoire

Conseil de Flux de Travail

Avant de tester n'importe quelle appelle API, collez votre payload JSON dans le Formatteur JSON pour valider la syntaxe et jolifier la structure. Une virgule de trop ou une clé mal citée passeraient inaperçues dans de nombreux clients HTTP -- attrapez-le visuellement en premier.

Liens Connexes

Métriques de Performance

Outils de Marketing

Sécurité

Programmation