Walidacja schematu JSON przed wywołaniami API

Weryfikacja schematu JSON przed wywołaniami API

JSON Schema jest umową, która określa strukturę, typy i ograniczenia dokumentu JSON. Weryfikacja ładunku przed wysłaniem go do API pozwala złapać błędy po stronie klienta zamiast debugowania nieczytelnych odpowiedzi 400.

Jak wygląda JSON Schema

{
  "$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"]
}

Ten schemat wymusza: email musi być prawidłowym ciągiem znaków w formacie email, age musi być liczbą całkowitą od 0 do 150, role musi być jednym z trzech wartości, a zarówno email, jak i role są wymagane.

Dlaczego weryfikować przed wysłaniem

Weryfikacja w JavaScript (ajv)

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

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

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: 'musi pasować do formatu "email"'}, ...]
}

Weryfikacja w Pythonie (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' jest wymagane

Porada dotycząca przepływu pracy

Przed przetestowaniem dowolnego wywołania API wklej ładunek JSON do JSON Formatter, aby zwalidować składnię i upiększyć strukturę. Pojedyncza przecinek na końcu lub źle cudzysłowiony klucz mogą zawieść w wielu klientach HTTP -- złap to wizualnie najpierw.

Powiązane