API Çağrılarından Önce JSON Şema Doğrulaması

JSON Şema Doğrulaması API Çağrılarından Önce

JSON Şema, bir JSON belgesinin yapısını, türlerini ve kısıtlamalarını tanımlayan bir sözleşmedir. Yük verilerini önceden bir API'ye göndermeden doğrulayın ve hataları istemci tarafında debug edilmesi zor 400 yanıtları yerine yakalayın.

JSON Şema Nasıl Görünür

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

Bu şema şunları zorunlu kılar: email geçerli bir e-posta dizisi olmalıdır, age 0-150 arası bir tamsayı olmalıdır, role üç değerden biri olmalıdır ve hem email hem de role gereklidir.

Göndermeden Önce Doğrulama Nedeni

JavaScript'te Doğrulama (ajv)

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

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

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'da Doğrulama (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

İş Akışı İpucu

Herhangi bir API çağrısını test etmeden önce, JSON yükünüzü JSON Formatlayıcı içine yapıştırın ve sözdizimini doğrulayın ve yapıyı güzelleştirin. Bir tek virgül veya yanlış tırnak işareti birçok HTTP istemcisinde sessizce başarısız olabilir -- önce görsel olarak yakalayın.

İlgili