Schema Builder

El Schema Builder es una herramienta sencilla que convierte la descripción de un modelo y sus campos en un esquema estructurado. Puedes usarlo para generar automáticamente la definición de un modelo que luego será consumido por otros componentes del dashboard.

¿Cómo funciona?

El componente toma tres piezas de información:

1. Model Name – el nombre que tendrá el modelo.
2. Model Description – una breve explicación de lo que representa el modelo.
3. Model Fields – la lista de campos que el modelo contiene, escrita en formato JSON.

Internamente, el componente analiza el JSON de los campos y genera un esquema de tipo BaseModel. Este esquema describe los tipos de datos, la obligatoriedad de cada campo y cualquier restricción adicional. Además, el componente ofrece una versión en texto plano (JSON) que puedes copiar o usar en otros flujos.

No se conecta a ninguna API externa; todo el procesamiento se realiza localmente dentro del entorno de Nappai.

Entradas

Campos de Entrada

• Model Description: La descripción del modelo que se va a construir.
• Model Fields: Los campos del modelo en formato JSON.
• Model Name: El nombre que tendrá el modelo.

Salidas

• Schema: Un objeto BaseModel que representa la estructura del modelo.
• JSON: Una cadena de texto con el esquema en formato JSON, útil para copiar o pasar a otros componentes.

Ejemplo de Uso

1. Configura el componente

   • En el campo Model Name escribe Customer.
   • En Model Description escribe Datos del cliente para la gestión de ventas.
   • En Model Fields pega el siguiente JSON:

   [
     {"name": "id", "type": "int", "required": true},
     {"name": "name", "type": "string", "required": true},
     {"name": "email", "type": "string", "required": false},
     {"name": "signup_date", "type": "date", "required": false}
   ]

2. Ejecuta el componente

   • El resultado aparecerá en las salidas Schema y JSON.
   • Copia el JSON generado y pégalo en un componente de validación o en un flujo que necesite la definición del modelo.

Componentes Relacionados

• JSON Parser – Convierte datos JSON en estructuras que otros componentes pueden usar.
• Data Validator – Valida datos contra un esquema generado por el Schema Builder.
• Model Deployer – Toma un esquema y crea la tabla o entidad correspondiente en tu base de datos.

Consejos y Mejores Prácticas

• Mantén la descripción breve: El campo Model Description no necesita ser extenso; solo lo suficiente para identificar el modelo.
• Valida el JSON de los campos: Asegúrate de que la sintaxis sea correcta antes de ejecutar el componente.
• Reutiliza esquemas: Guarda los esquemas generados en la biblioteca de componentes para usarlos en otros flujos.
• Controla la visibilidad: Si el esquema contiene datos sensibles, evita exponerlo en flujos públicos.

Consideraciones de Seguridad

• El componente no almacena ni transmite datos sensibles fuera del entorno de Nappai.
• Si tu modelo incluye información confidencial, considera enmascarar o eliminar esos campos antes de generar el esquema.
• Asegúrate de que solo usuarios autorizados tengan acceso a la salida JSON si contiene datos críticos.