Проверка схемы JSON перед вызовами API

Валидация JSON Schema перед вызовами API

JSON Schema -- это контракт, описывающий структуру, типы и ограничения JSON-документа. Валидируйте данные до отправки в API -- и ловите ошибки на клиенте, а не разбирайте загадочные 400-е ответы.

Как выглядит 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"]
}

Эта схема гарантирует: email должен быть валидной email-строкой, age -- целое число 0-150, role -- одно из трёх значений, а email и role обязательны.

Зачем валидировать до отправки

Валидация в JavaScript (ajv)

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

const ajv = new Ajv();
addFormats(ajv); // добавляет "email", "uri", "date-time" и др.

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"'}, ...]
}

Валидация в 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' is a required property

Совет по рабочему процессу

Перед тестированием любого API-вызова вставьте JSON-пейлоад в JSON Formatter, чтобы проверить синтаксис и отформатировать структуру. Лишняя запятая или неправильно экранированный ключ -- и многие HTTP-клиенты молча провалятся. Ловите такое визуально.

Связанные материалы