@rewritetoday/typebox fornece schemas oficiais em TypeBox para a API da Rewrite, permitindo validar requests, responses, recursos reutilizaveis e payloads de webhook em runtime.
Repositorio: github.com/RewriteToday/typebox
Quando usar
- Quando voce prefere TypeBox como camada de validacao em runtime.
- Quando quer validacao em runtime alem dos tipos TypeScript.
- Quando recebe input externo antes de chamar endpoints da Rewrite.
- Quando precisa de schemas versionados alinhados aos modelos da API Rewrite.
Capacidades principais
Schemas versionados
Importe schemas de namespaces como
@rewritetoday/typebox/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
Valide payloads
WebhookEvent antes de desviar pela familia de evento da Rewrite.Instalacao
Exemplo de validacao de request
Exemplo de validacao de webhook
Boas praticas
Mantenha versoes explicitas
Mantenha versoes explicitas
Importe de um namespace especifico, como
@rewritetoday/typebox/v1, para manter upgrades intencionais.Valide nas bordas
Valide nas bordas
Faca parse do input externo antes de ele chegar na logica de negocio para falhar cedo e com previsibilidade.
Combine validacao e transporte
Combine validacao e transporte
Use
@rewritetoday/typebox junto com @rewritetoday/rest e @rewritetoday/types para fechar validacao, rotas e transporte na mesma stack.Documentacao relacionada
Biblioteca Zod
Schemas oficiais em Zod para times que preferem o modelo de validacao do Zod.
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 TypeBox.