JSON-Schemavalidierung vor API-Aufrufen

JSON-Schemavalidierung vor API-Aufrufen

JSON Schema ist ein Vertrag, der die Struktur, Typen und Einschränkungen eines JSON-Dokuments definiert. Validieren Sie Payloads vor dem Senden an eine API, und Sie fangen Fehler clientseitig, anstatt kryptische 400-Antworten zu debuggen.

Wie JSON Schema aussieht

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

Dieses Schema erzwingt: email muss eine gültige E-Mail-Zeichenfolge sein, age muss eine Ganzzahl zwischen 0 und 150 sein, role muss einer von drei Werten sein, und sowohl email als auch role sind erforderlich.

Warum vor dem Senden validieren

Validierung in JavaScript (ajv)

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

const ajv = new Ajv();
addFormats(ajv); // fügt "email", "uri", "date-time" usw. hinzu

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: 'muss dem Format "email" entsprechen"'}, ...]
}

Validierung in 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' ist ein erforderliches Feld

Workflow-Tipp

Bevor Sie einen API-Aufruf testen, fügen Sie Ihren JSON-Payload in den JSON Formatter ein, um die Syntax zu validieren und die Struktur zu verschönern. Ein einzelnes abschließendes Komma oder ein falsch zitierter Schlüssel kann in vielen HTTP-Clients stillschweigend fehlschlagen -- erkennen Sie es zuerst visuell.

Verwandte Themen