JSON in Zod-Schema
Füge Beispiel-JSON ein, etwa eine API-Antwort oder ein Formular-Payload, und erhalte ein sofort einsetzbares Zod-Schema mit verschachtelten Objektschemas, Arrays, aus deinen Daten erkanntem .optional() und .nullable() sowie exportierten z.infer-Typen. Wechsle mit einem Klick zu Zod 3 oder Yup. Alles läuft in deinem Browser.
Zuletzt aktualisiert:
Dein JSON wird lokal in diesem Tab verarbeitet und nie hochgeladen. Tipp: Strg + Eingabe erzeugt den Code.
Anleitung: JSON in Zod-Schema
- Füge Beispiel-JSON in das linke Feld ein oder öffne eine .json-Datei. Hast du mehrere Beispiele, füge sie als Array ein, damit optionale Schlüssel erkannt werden.
- Benenne das Root-Schema, zum Beispiel user, woraus userSchema und der Typ User entstehen.
- Wähle die Bibliothek (Zod 4, Zod 3 oder Yup) und ob verschachtelte Objekte eigene benannte Schemas erhalten.
- Lege die Optionen fest: Erkennung von optional, Typ-Exporte, .int(), String-Formate und strikte Objekte.
- Kopiere oder lade das Schema herunter und validiere Daten mit userSchema.safeParse(data).
Beispiel: Zod-Schema aus JSON ableiten
Fügst du zwei Beispielbestellungen als Array ein, erkennt der Generator, dass coupon manchmal fehlt und note manchmal null ist:
[ { "id": 1, "email": "[email protected]", "total": 19.99, "note": null, "items": [ { "sku": "A1", "qty": 2 } ] },
{ "id": 2, "email": "[email protected]", "total": 5, "note": "Gift", "coupon": "SAVE10", "items": [] } ]Mit dem Root-Namen order und ausgewähltem Zod 4 lautet das Ergebnis:
import { z } from 'zod';
export const itemSchema = z.object({
sku: z.string(),
qty: z.number().int(),
});
export const orderSchema = z.object({
id: z.number().int(),
email: z.email(),
total: z.number(),
note: z.string().nullable(),
items: z.array(itemSchema),
coupon: z.string().optional(),
});
export const orderListSchema = z.array(orderSchema);
export type Item = z.infer<typeof itemSchema>;
export type Order = z.infer<typeof orderSchema>;
export type OrderList = z.infer<typeof orderListSchema>;Wie JSON-Werte auf Zod und Yup abgebildet werden
| Beispielwert | Zod 4 | Zod 3 | Yup |
|---|---|---|---|
"Text" | z.string() | z.string() | yup.string() |
"[email protected]" | z.email() | z.string().email() | yup.string().email() |
"2024-05-01T09:30:00Z" | z.iso.datetime() | z.string().datetime() | yup.string().datetime() |
42 | z.number().int() | z.number().int() | yup.number().integer() |
4.5 | z.number() | z.number() | yup.number() |
true | z.boolean() | z.boolean() | yup.boolean() |
[ … ] | z.array(…) | z.array(…) | yup.array().of(…) |
{} | z.record(z.string(), z.unknown()) | z.record(z.unknown()) | yup.object() |
Wert oder null | .nullable() | .nullable() | .nullable().defined() |
| Schlüssel fehlt manchmal | .optional() | .optional() | (kein .required()) |
Tipps für bessere Schemas
- Verwende mehrere Beispiele. Ein einzelnes Objekt kann nicht zeigen, welche Schlüssel optional sind. Füge ein Array echter Antworten ein, einschließlich Grenzfällen wie leeren Listen und null-Werten.
- Verfeinere das Ergebnis von Hand. Die Ableitung sieht nur dein Beispiel. Ergänze Einschränkungen, die du kennst, etwa
.min(1),.max(100),.positive()oderz.enum(['draft', 'published'])für feste Wertemengen. - Parse an der Grenze. Rufe
schema.parse()odersafeParse()dort auf, wo nicht vertrauenswürdige Daten in deine App gelangen (API-Antworten, Formularübermittlungen, Umgebungsvariablen), und verwende überall sonst den abgeleiteten Typ. - Brauchst du ein sprachneutrales Schema? Nutze stattdessen den JSON-Schema-Generator für ein JSON Schema nach draft 2020-12.
Häufige Fragen
Wie entscheidet der Generator, was optional oder nullable ist?
Er liest jeden Wert in deinem Beispiel. Ein Schlüssel, der in manchen Objekten eines Arrays fehlt, wird zu .optional(), ein Wert, der irgendwo null ist, zu .nullable(), und ein Wert, auf den beides zutrifft, zu .nullish(). Bei einem einzelnen Objekt kann nichts fehlen, füge für beste Ergebnisse daher ein Array mehrerer echter Beispiele ein. Du kannst auch jedes Feld als optional markieren.
Was ist der Unterschied zwischen der Ausgabe für Zod 4 und Zod 3?
Zod 4 hat String-Formate auf oberster Ebene, sodass eine E-Mail z.email(), eine URL z.url() und ein ISO-Zeitstempel z.iso.datetime() ist, und z.record() nimmt ein Schlüssel- und ein Wertschema. Zod 3 verwendet den Methodenstil, etwa z.string().email() und z.string().datetime(). Alles andere, einschließlich z.object, z.array und z.infer, ist gleich.
Wie erhalte ich einen TypeScript-Typ aus dem Schema?
Mit aktiviertem z.infer-Typ exportieren erhält jedes benannte Schema einen passenden Typ, zum Beispiel export type User = z.infer<typeof userSchema>. Der Typ wird aus dem Schema abgeleitet, sodass du nur eine einzige Quelle der Wahrheit pflegst. Für Yup schreibt der Generator yup.InferType<typeof userSchema>.
Warum ist ein Feld als z.null() oder z.union() typisiert?
Ist ein Wert im Beispiel überall null, lässt sich sein echter Typ nicht ableiten, daher akzeptiert das Schema nur null; ersetze es durch etwas wie z.string().nullable(), sobald du den Typ kennst. Enthält ein Feld an verschiedenen Stellen unterschiedliche Typen, etwa einen String in einem Element und eine Zahl in einem anderen, schreibt der Generator z.union([...]) mit jedem gefundenen Typ.
Werden String-Formate wie E-Mail und UUID immer erkannt?
Ein Format wird nur hinzugefügt, wenn jeder String-Wert dieses Felds dazu passt, zum Beispiel jeder Wert wie eine E-Mail-Adresse aussieht. Datumswerte müssen vollständige ISO-8601-Zeitstempel wie 2024-05-01T09:30:00Z sein (mit { offset: true }, wenn das Beispiel Offsets im Stil +02:00 verwendet). Schalte die Formaterkennung aus, wenn deine echten Daten dem Format nicht immer folgen.
Unterstützt Yup alles, was Zod kann?
Das meiste. Yup hat keinen Union-Typ, daher werden Felder mit gemischten Typen zu yup.mixed(). Pflichtfelder verwenden .required(), Felder, die null sein können, aber vorhanden sind, verwenden .nullable().defined(), und fehlende Schlüssel bleiben optional, was der Standard von Yup ist.
Wird mein JSON hochgeladen?
Nein. Dein JSON wird von JavaScript auf dieser Seite geparst und das Schema dort erzeugt. Nichts wird an einen Server gesendet.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.