Skip to main content
@rewritetoday/zod fornece schemas oficiais em Zod para a API da Rewrite, permitindo validar requests, responses, recursos reutilizaveis e payloads de webhook em runtime. Repositorio: github.com/RewriteToday/zod

Quando usar

  • Quando voce quer validacao em runtime alem dos tipos TypeScript.
  • Quando recebe input externo antes de chamar endpoints da Rewrite.
  • Quando precisa validar payloads de webhook antes de processa-los.
  • Quando quer schemas versionados alinhados aos modelos da API Rewrite.

Capacidades principais

Schemas versionados

Importe schemas de namespaces como @rewritetoday/zod/v1.

Contratos REST

Valide bodies e responses especificos de endpoint com schemas REST<Method>*.

Modelos reutilizaveis

Faca parse de recursos API* compartilhados sem depender de um unico endpoint.

Seguranca para webhooks

Use WebhookEvent.safeParse(...) para proteger o processamento de webhooks na borda.

Instalacao

Exemplo de validacao de request

Exemplo de validacao de webhook

Boas praticas

Faca parse do input externo antes de ele chegar na logica de negocio para falhar cedo e com previsibilidade.
Importe de um namespace especifico, como @rewritetoday/zod/v1, para manter upgrades intencionais.
Use @rewritetoday/zod junto com @rewritetoday/rest e @rewritetoday/types para fechar validação, rotas e transporte na mesma stack.

Documentacao relacionada

Biblioteca Types

Contratos compartilhados e builders de rota que complementam a validacao em runtime.

Biblioteca REST

Cliente de transporte de baixo nivel para enviar os payloads validados com Zod.