¡Convierte modelos de Sequelize (JS) en JSON!

¡Introduce modelos de Sequelize (JS) para generar JSON de ejemplo! Compatible con Sequelize define, DataTypes. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
Sequelize (JS)
Resultado
 

¡Convierte modelos de Sequelize (JS) en JSON!

Lee modelos de Sequelize escritos en JavaScript puro, sequelize.define("User", {...}) o Model.init({...}, {...}), y los convierte en JSON de ejemplo. Como no hay anotaciones de tipo en las que apoyarse, el valor de cada atributo se elige a partir de su entrada DataTypes.

Encaja en servidores Node.js antiguos con Express y Sequelize sin TypeScript, donde el archivo del modelo es la única descripción de cómo es una respuesta de la API o una fila de seed.

Cómo usar

  1. Pega el archivo del modelo en el cuadro Sequelize (JS). No pasa nada si quedan líneas require o module.exports.
  2. Si el archivo define varios modelos, la salida se organiza por nombre de modelo, p. ej. { "User": {...}, "Post": {...} }.
  3. Comprueba que se reflejan las opciones del modelo (el segundo argumento) como timestamps, paranoid o un createdAt renombrado, y luego copia.

Ejemplo

Entrada (Sequelize · JavaScript)
class Reservation extends Model {}

Reservation.init(
  {
    code: { type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true },
    guests: DataTypes.SMALLINT,
    checkIn: DataTypes.DATEONLY,
    arrivalTime: DataTypes.TIME,
    options: DataTypes.JSONB,
    tags: DataTypes.ARRAY(DataTypes.STRING),
  },
  { sequelize, modelName: "Reservation", updatedAt: false }
);
Salida (JSON)
{
  "code": "00000000-0000-0000-0000-000000000000",
  "guests": 0,
  "checkIn": "1970-01-01",
  "arrivalTime": "00:00:00",
  "options": {},
  "tags": [
    ""
  ],
  "createdAt": "1970-01-01T00:00:00.000Z"
}

code tiene primaryKey: true, así que no se añade id, y su defaultValue es DataTypes.UUIDV4, un generador y no un literal, así que se muestra el UUID placeholder. updatedAt: false deja createdAt como único timestamp, y DATEONLY, TIME, JSONB y ARRAY(STRING) pasan a una cadena de fecha, una cadena de hora, un objeto vacío y un array de un elemento.

Funciones compatibles

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • DATE da 1970-01-01T00:00:00.000Z, DATEONLY da 1970-01-01 y TIME da 00:00:00.
  • UUID pasa a una cadena UUID todo ceros, ENUM("admin", "user") a su primer valor, y JSON/JSONB a un objeto vacío.
  • ARRAY(DataTypes.STRING) sigue su tipo de elemento, y VIRTUAL(DataTypes.STRING) se rellena a partir del tipo interior.
  • Las opciones de modelo timestamps: false, updatedAt: false, createdAt: "created_on" y paranoid: true añaden, quitan o renombran los atributos de fecha.
  • Se entienden tanto la forma larga { type: ..., allowNull: ... } como la corta DataTypes.X.

Casos de uso

Esbozar datos para seeders

Parte de la salida al escribir el array de objetos para queryInterface.bulkInsert, para que los nombres de las claves y los tipos coincidan con el modelo. Quita el id generado y los timestamps donde los rellena la base de datos.

Leer código legacy sin tipos

Sin TypeScript cuesta saber qué JSON envía un modelo solo con leerlo. Pasar por aquí cada archivo de modelo te da un mapa rápido de las formas de respuesta de la API.

Notas y limitaciones

  • Un defaultValue literal ("pending", 1, true) pasa a ser el valor de ejemplo. Los defaults generados como DataTypes.NOW, DataTypes.UUIDV4 o sequelize.fn(...) recurren al placeholder del tipo.
  • Las asociaciones como hasMany y belongsTo están fuera de la definición del modelo, así que no aparecen en la salida. Añade a mano los datos que cargas con include.
  • En MySQL y PostgreSQL, DECIMAL suele volver como cadena en runtime, pero el ejemplo muestra 0.
  • Los tipos sin un valor de ejemplo evidente, como GEOMETRY, pasan a null.

Preguntas frecuentes

Configuré underscored: true. ¿Por qué sale createdAt y no created_at?

underscored solo cambia a snake_case los nombres de columna de la base de datos. Los nombres de atributo que usa toJSON() siguen siendo createdAt, así que la salida coincide. Para cambiar también la clave JSON, nómbrala explícitamente con createdAt: "created_at".

¿Funciona cuando class User extends Model {} y User.init() están separados?

Sí. El identificador justo antes de .init( se usa como nombre del modelo, y el primer argumento se lee como el mapa de atributos.

¿Dónde convierto los modelos de TypeScript con decoradores?

Usa la página Sequelize (TS) a JSON para los modelos de sequelize-typescript con @Table y @Column. Esa página lee los tipos de las propiedades en lugar de DataType.