JSON'dan Zod Şema Dönüştürücü

Zod şeması nedir?

Örnekler

{"id":101,"name":"Ada Lovelace","email":"ada@example.com","active":true,"roles":["admin","user"]}

import { z } from "zod";

export const RootSchema = z.object({
  id: z.number().int(),
  name: z.string(),
  email: z.string(),
  active: z.boolean(),
  roles: z.array(z.string()),
});

export type Root = z.infer<typeof RootSchema>;

{"repo":"zod","owner":{"login":"colinhacks","id":100}}

import { z } from "zod";

export const OwnerSchema = z.object({
  login: z.string(),
  id: z.number().int(),
});

export const RootSchema = z.object({
  repo: z.string(),
  owner: OwnerSchema,
});

export type Root = z.infer<typeof RootSchema>;

{"users":[{"id":1,"nick":"x"},{"id":2}]}

import { z } from "zod";

export const UserSchema = z.object({
  id: z.number().int(),
  nick: z.string().optional(),
});

export const RootSchema = z.object({
  users: z.array(UserSchema),
});

export type Root = z.infer<typeof RootSchema>;

{"items":[{"sku":"A1","discount":0.1},{"sku":"A2","discount":null}]}

import { z } from "zod";

export const ItemSchema = z.object({
  sku: z.string(),
  discount: z.number().nullable(),
});

export const RootSchema = z.object({
  items: z.array(ItemSchema),
});

export type Root = z.infer<typeof RootSchema>;

JSON nasıl Zod'a dönüştürülür

1. 1

   JSON'unuzu yapıştırın

   Giriş kutusuna bir JSON nesnesi, dizisi veya API yanıtı bırakın. Dönüştürme anında başlar.

2. 2

   Çıktıyı ayarlayın

   Projenizin stiline uyması için kök şemayı yeniden adlandırın ve import satırını, z.infer türünü veya export anahtar sözcüğünü açıp kapatın.

3. 3

   Kopyalayın veya indirin

   Oluşturulan Zod şemasını tek tıkla alın ve doğrudan doğrulama katmanınıza yapıştırın.

Common Use Cases

API yanıtlarını doğrulayın

Bir REST veya GraphQL yanıtı örneğini bir Zod şemasına dönüştürün ve fetch sınırında ayrıştırın, böylece bozuk veri uygulamanıza sızmak yerine net bir hatayla hızlıca başarısız olur.

Tür güvenli formlar ve girişler

Form veya sorgu girişi için bir şema oluşturun ve uçtan uca tür güvenliği için z.infer türünü kullanıcı arayüzünüz ve işleyicileriniz genelinde yeniden kullanın.

tRPC ve yapay zekâ araç şemaları

tRPC prosedürleri veya yapay zekâ yapılandırılmış çıktı araçları için giriş ve çıkış şemalarını elle yazmak yerine örnek bir yükten önyükleyin.

Dönüştürme nasıl çalışır

Yapısal çıkarım

Her nesne adlandırılmış bir şema olur; aynı biçimler bir kez bildirilip yeniden kullanılır. Nesne dizileri anahtar anahtar birleşir ve bazı öğelerde bulunmayan anahtarlar .optional() olur.

Doğru tür eşleme

Tam sayılar z.number().int()'e, ondalıklar z.number()'a eşlenir. Dizeler, boolean'lar ve null'lar z.string(), z.boolean() ve z.null()'a eşlenir; karışık ilkellerden oluşan bir dizi z.union() olur.

TypeScript türleri dahil

Kök şema için bir z.infer tür takma adı yayılır, böylece şema tek doğruluk kaynağı olarak kalır ve türleriniz doğrulamanızdan asla ayrışmaz.

%100 istemci tarafı

Ayrıştırma ve oluşturma, ağ çağrısı olmadan tarayıcınızda çalışır; böylece verileriniz gizli kalır.

Temiz Zod şemaları için ipuçları

Kök şemanızı adlandırın

Okunabilir, kendini belgeleyen kod için varsayılan Root yerine User veya ApiResponse gibi anlamlı bir kök adı belirleyin.

z.unknown() ve union'ları inceltin

Boş veya karışık diziler z.unknown() ya da geniş bir z.union() üretir. Aracın kesin türleri çıkarabilmesi için daha zengin, temsili bir örnek yapıştırın, sonra belirsiz kalan her şeyi sıkılaştırın.

Sınırda doğrulayın

Güvenilmeyen verilerin girdiği yerde safeParse() çağırın — API yanıtları, form girişi, webhook'lar — böylece kötü veri uygulama mantığınıza ulaşmadan yakalanır.

Sıkça Sorulan Sorular