Converta modelos Sequelize (JS) em JSON!

Insira modelos Sequelize (JS) para gerar JSON de exemplo! Compatível com Sequelize define, DataTypes. Útil para documentar APIs e corpos de requisição de teste (mock request body).
Sequelize (JS)
Resultado
 

Converta modelos Sequelize (JS) em JSON!

Lê models Sequelize escritos em JavaScript puro, sequelize.define("User", {...}) ou Model.init({...}, {...}), e os transforma em JSON de exemplo. Sem anotações de tipo para se basear, o valor de cada atributo é escolhido a partir da sua entrada em DataTypes.

Combina com servidores Node.js mais antigos rodando Express e Sequelize sem TypeScript, em que o arquivo de model é a única descrição de como é uma resposta da API ou uma linha de seed.

Como usar

  1. Cole o arquivo de model na caixa Sequelize (JS). Linhas de require e module.exports que sobrarem não atrapalham.
  2. Se o arquivo define vários models, a saída é organizada por nome do model, por exemplo { "User": {...}, "Post": {...} }.
  3. Confira se as opções do model (o segundo argumento), como timestamps, paranoid ou um createdAt renomeado, estão refletidas e copie.

Exemplo

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 }
);
Saída (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 tem primaryKey: true, então nenhum id é adicionado, e o defaultValue dele é DataTypes.UUIDV4, um gerador e não um literal, por isso aparece o UUID placeholder. updatedAt: false deixa createdAt como único timestamp, e DATEONLY, TIME, JSONB e ARRAY(STRING) viram uma string de data, uma string de hora, um objeto vazio e um array de um elemento.

Recursos suportados

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • DATE gera 1970-01-01T00:00:00.000Z, DATEONLY gera 1970-01-01 e TIME gera 00:00:00.
  • UUID vira uma string UUID toda zerada, ENUM("admin", "user") o seu primeiro valor e JSON/JSONB um objeto vazio.
  • ARRAY(DataTypes.STRING) segue o tipo do elemento, e VIRTUAL(DataTypes.STRING) é preenchido a partir do tipo interno.
  • As opções de model timestamps: false, updatedAt: false, createdAt: "created_on" e paranoid: true adicionam, removem ou renomeiam os atributos de data.
  • Tanto a forma longa { type: ..., allowNull: ... } quanto a curta DataTypes.X são entendidas.

Casos de uso

Rascunhar dados de seeder

Parta da saída ao escrever o array de objetos para queryInterface.bulkInsert, para que nomes de chave e tipos batam com o model. Remova o id e os timestamps gerados onde o banco os preenche.

Ler código legado sem tipos

Sem TypeScript, é difícil saber que JSON um model manda só lendo o código. Passar cada arquivo de model por aqui dá um mapa rápido dos formatos de resposta da API.

Observações e limitações

  • Um defaultValue literal ("pending", 1, true) vira o valor de exemplo. Defaults gerados como DataTypes.NOW, DataTypes.UUIDV4 ou sequelize.fn(...) caem no placeholder do tipo.
  • Associações como hasMany e belongsTo ficam fora da definição do model, então não aparecem na saída. Adicione à mão os dados que você carrega com include.
  • No MySQL e no PostgreSQL, DECIMAL normalmente volta como string em runtime, mas o exemplo mostra 0.
  • Tipos sem um valor de exemplo óbvio, como GEOMETRY, viram null.

Perguntas frequentes

Eu defini underscored: true. Por que está createdAt e não created_at?

O underscored só muda os nomes das colunas do banco para snake_case. Os nomes de atributo usados pelo toJSON() continuam createdAt, então a saída bate. Para mudar também a chave JSON, nomeie explicitamente com createdAt: "created_at".

Funciona quando class User extends Model {} e User.init() estão separados?

Sim. O identificador logo antes de .init( é usado como nome do model, e o primeiro argumento é lido como o mapa de atributos.

Onde converto models TypeScript com decorators?

Use a página Sequelize (TS) para JSON para models do sequelize-typescript com @Table e @Column. Aquela página lê os tipos das propriedades em vez do DataType.