Zod-Schemas aus API-Antwort generieren
Dieses Beispiel erzeugt Zod-Schemas mit TypeScript-Typinferenz aus einer typischen REST-API-Antwort. Die vorausgefüllte JSON repräsentiert ein Benutzerobjekt mit verschachtelter Adresse, einem Array von Rollen und einem Array von Beitrag-Objekten. Wechseln Sie zum Zod-Modus, um die erzeugten Schemas zu sehen.
Was Sie Bekommen
Das Werkzeug erzeugt:
- Ein Root-
RootSchemamitz.object()und allen Feldern der obersten Ebene RootUserAddressSchemafür das verschachtelte AdressobjektRootPostsItemSchemafür Array-Elementez.optional()für fehlende Felder in einigen Array-Elementen- TypeScript-Typen abgeleitet über
z.infer<typeof SchemaName> - Korrekte Imports aus
zod
So verwenden Sie es
- Das Beispiel lädt mit einer Beispiel-API-Antwort und dem vorausgewählten Zod-Modus
- Untersuchen Sie die erzeugten Schemas und abgeleiteten Typen
- Kopieren Sie den Code und fügen Sie ihn in Ihr TypeScript-Projekt ein (installieren Sie zuerst zod:
npm install zod) - Ersetzen Sie durch Ihre tatsächliche API-Antwort, um Schemas für Ihre Endpunkte zu erzeugen
Muster aus der Praxis
Zod-Schemas bieten sowohl Laufzeitvalidierung als auch Kompilierzeit-Typsicherheit aus einer einzigen Definition. Verwenden Sie schema.parse(data), um API-Antworten, Formulareingaben oder externe Daten zu validieren. Die abgeleiteten Typen eliminieren Duplizierung zwischen Ihrer Validierungslogik und TypeScript-Interfaces.