JSON-Schema-Generator

Was die Inferenz gut macht

• Typen: string, number, integer, boolean, null, array, object.
• Nullbarkeit: Ein Feld, das in einem Beispiel null und in einem anderen einen String hat, wird zu ["string", "null"].
• Array-Elemente: Homogene Arrays erzeugen ein einzelnes items-Schema; heterogene Arrays erzeugen prefixItems.
• Aufzählungen (enum): Wenn alle beobachteten Werte aus einer kleinen Menge stammen (konfigurierbar, standardmäßig 10 verschiedene Werte), wird ein enum ausgegeben.
• Erforderlich: Bei mehreren Beispielen wird die Schnittmenge der Schlüssel zu required; bei einem Beispiel sind alle Schlüssel erforderlich, es sei denn, Sie entscheiden sich dagegen.
• Formate: Strings, die ISO-8601-Daten, E-Mails oder URIs entsprechen, erhalten ein abgeleitetes format.

Was die Inferenz nicht wissen kann

• Absicht vs. Beispiel: Ein Beispiel age: 25 leitet type: integer ab, kann aber nicht wissen, dass Sie auch null akzeptieren. Geben Sie mehrere Beispiele an, die Randfälle abdecken.
• Einschränkungen: minLength, maximum, pattern, diese müssen Sie manuell hinzufügen. Die Inferenz rät keine Grenzen aus Beispielen.
• Geschäftslogik: “Genau eines dieser drei Felder muss gesetzt sein” erfordert oneOf, nicht ableitbar.
• Referenzen: Der Generator gibt ein flaches Schema aus. Wenn Sie wiederholte Formen in $defs auslagern möchten, tun Sie dies nach der Generierung.

Beispielausgabe

Von einem einzelnen Beispiel:

{ "name": "Alice", "age": 30, "tags": ["admin", "user"] }

Das abgeleitete Schema (Entwurf 2020-12):

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "integer" },
    "tags": { "type": "array", "items": { "type": "string" } }
  },
  "required": ["name", "age", "tags"]
}

Häufige Fehler

• Ableiten aus einem Beispiel. Das Schema wird überangepasst, jedes Feld wird erforderlich, keine Nulltoleranz. Geben Sie immer mindestens 5-10 verschiedene Beispiele an.
• Verwendung von integer, wenn Sie number meinten. Wenn ein Beispiel eine Dezimalzahl hat, wird der abgeleitete Typ number; wenn alle ganzzahlig sind, wird er integer. Für Felder, die beides sein könnten, fügen Sie ein Dezimalbeispiel hinzu.
• Vergessen von optionalen Feldern. Ein Feld, das in 4 von 5 Beispielen vorhanden, aber in 1 Beispiel fehlt, wird optional, beabsichtigt. Wenn alle 5 Beispiele es zufällig enthalten, wird das Schema es als erforderlich markieren, obwohl es in Ihrer API tatsächlich optional ist.