Ir al contenido
snowkitDev

Genera un JSON Schema a partir de JSON, directamente en tu navegador

Pega la respuesta de una API o cualquier muestra de JSON y obtén un JSON Schema que coincida con su forma.

JSON a tipos

Pega JSON y elige el lenguaje que necesitas.

Descargar

Los arreglos se combinan, así que los campos que faltan en algunos elementos pasan a ser opcionales.

Los objetos anidados se convierten en tipos con nombre, y los campos que faltan en algunos elementos pasan a ser opcionales. Pega una muestra de JSON y obtén tipos listos para usar en TypeScript, Zod, Go, Python o JSON Schema. Se ejecuta en tu navegador y es gratis y privado.

Cómo convertir JSON a tipos

  1. Pega tu JSON en JSON, o pulsa Probar un ejemplo.
  2. Elige la salida: TypeScript, Zod, Go, Python o JSON Schema.
  3. Lee el código generado.
  4. Pulsa Copiar código o Descargar.

Qué hace esta herramienta

Lee tu JSON, deduce el tipo de cada valor y escribe código que describe esa forma. Los arreglos de objetos se combinan, así que un campo que aparece solo en algunos elementos se marca como opcional, y un campo que a veces es un número y a veces texto se convierte en una unión.

Cinco salidas

Interfaces de TypeScript para código de front-end y Node. Esquemas de Zod que validan datos en tiempo de ejecución y te dan el tipo gratis. Structs de Go con etiquetas json, usando punteros para campos opcionales. Dataclasses de Python con anotaciones de tipo modernas. JSON Schema (draft 2020-12) para validadores y documentación de API.

Consejos para mejores tipos

  • Usa una muestra con varios elementos en cada arreglo para que se detecten los campos opcionales.
  • Incluye valores para los campos que a veces están vacíos, para que el tipo no sea demasiado estrecho.
  • Cambia el nombre del tipo raíz generado por algo significativo para tu proyecto.
  • Usa la salida como punto de partida y luego ajústala a mano, por ejemplo convirtiendo campos de texto en valores permitidos concretos.
  • Comprueba primero que tu JSON sea válido con las herramientas JSON.

Quién lo usa

Desarrolladores que trabajan con una API nueva, estudiantes que aprenden cómo se estructuran los datos y freelancers que conectan el sistema de un cliente con un sitio web. Para describir una herramienta para un modelo de IA, usa el creador de esquemas de funciones.

Privacidad

Las respuestas de API suelen contener datos reales de usuarios. Aquí nunca salen de tu navegador: los tipos se generan en este dispositivo.

Preguntas

¿Cómo se tratan las fechas?

Las cadenas que parecen fechas ISO se convierten en time.Time en Go y reciben una validación de fecha en Zod y JSON Schema. Los demás lenguajes las mantienen como cadenas.

¿Y si mi muestra está incompleta?

Los tipos solo pueden describir los datos que ven. Pega una respuesta con tantos campos rellenos como sea posible, o varios elementos en un arreglo, para obtener el resultado más preciso.

¿Qué pasa con los valores null?

Un campo que a veces es null se convierte en una unión con null, o en un campo opcional, según el lenguaje.

Qué hacer ahora

Sigue con lo que acabas de crear, todavía en tu dispositivo.

Más de Snowkit