Ubah model Sequelize (JS) menjadi JSON!

Masukkan model Sequelize (JS) untuk membuat contoh JSON! Mendukung Sequelize define, DataTypes. Berguna untuk dokumentasi API dan body request uji (mock request body).
Sequelize (JS)
Hasil
 

Ubah model Sequelize (JS) menjadi JSON!

Alat ini membaca model Sequelize yang ditulis dalam JavaScript biasa, sequelize.define("User", {...}) atau Model.init({...}, {...}), dan mengubahnya menjadi contoh JSON. Karena tidak ada anotasi tipe sebagai pegangan, nilai setiap atribut dipilih dari entri DataTypes-nya.

Cocok untuk server Node.js lama yang menjalankan Express dan Sequelize tanpa TypeScript, di mana file model adalah satu-satunya deskripsi bentuk respons API atau baris seed.

Cara menggunakan

  1. Tempel file model ke kolom Sequelize (JS). Sisa baris require dan module.exports tidak masalah.
  2. Jika file mendefinisikan beberapa model, output diberi key sesuai nama model, misalnya { "User": {...}, "Post": {...} }.
  3. Periksa bahwa opsi model (argumen kedua) seperti timestamps, paranoid atau createdAt yang diganti namanya sudah tercermin, lalu salin.

Contoh

Input (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 }
);
Output (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 memiliki primaryKey: true, jadi tidak ada id yang ditambahkan, dan defaultValue-nya adalah DataTypes.UUIDV4, sebuah generator dan bukan literal, sehingga yang ditampilkan adalah UUID placeholder. updatedAt: false menyisakan createdAt sebagai satu-satunya timestamp, dan DATEONLY, TIME, JSONB serta ARRAY(STRING) menjadi string tanggal, string waktu, objek kosong, dan array satu elemen.

Fitur yang didukung

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • DATE menghasilkan 1970-01-01T00:00:00.000Z, DATEONLY menghasilkan 1970-01-01 dan TIME menghasilkan 00:00:00.
  • UUID menjadi string UUID berisi nol semua, ENUM("admin", "user") menjadi nilai pertamanya, dan JSON/JSONB menjadi objek kosong.
  • ARRAY(DataTypes.STRING) mengikuti tipe elemennya, dan VIRTUAL(DataTypes.STRING) diisi dari tipe di dalamnya.
  • Opsi model timestamps: false, updatedAt: false, createdAt: "created_on" dan paranoid: true menambah, membuang, atau mengganti nama atribut tanggal.
  • Bentuk panjang { type: ..., allowNull: ... } maupun bentuk pendek DataTypes.X sama-sama dipahami.

Kasus penggunaan

Menyusun draf data seeder

Mulailah dari output saat menulis array objek untuk queryInterface.bulkInsert, agar nama key dan tipenya cocok dengan model. Hapus id dan timestamp yang dihasilkan jika database yang mengisinya.

Membaca kode lama tanpa tipe

Tanpa TypeScript, sulit mengetahui JSON apa yang dikirim sebuah model hanya dengan membacanya. Memproses setiap file model di sini memberi peta cepat tentang bentuk respons API.

Catatan dan batasan

  • defaultValue berupa literal ("pending", 1, true) menjadi nilai contoh. Default yang dibangkitkan seperti DataTypes.NOW, DataTypes.UUIDV4 atau sequelize.fn(...) kembali ke placeholder tipenya.
  • Asosiasi seperti hasMany dan belongsTo berada di luar definisi model, jadi tidak ada di output. Tambahkan secara manual data yang Anda muat dengan include.
  • Di MySQL dan PostgreSQL, DECIMAL biasanya dikembalikan sebagai string saat runtime, tetapi contoh menampilkan 0.
  • Tipe yang tidak punya nilai contoh yang jelas, seperti GEOMETRY, menjadi null.

FAQ

Saya mengatur underscored: true. Mengapa hasilnya createdAt, bukan created_at?

underscored hanya mengubah nama kolom database menjadi snake_case. Nama atribut yang dipakai toJSON() tetap createdAt, jadi output-nya sesuai. Untuk mengubah key JSON juga, beri nama secara eksplisit dengan createdAt: "created_at".

Apakah tetap berfungsi jika class User extends Model {} dan User.init() terpisah?

Ya. Identifier tepat sebelum .init( dipakai sebagai nama model, dan argumen pertama dibaca sebagai peta atribut.

Di mana saya mengonversi model decorator TypeScript?

Gunakan halaman Sequelize (TS) ke JSON untuk model sequelize-typescript dengan @Table dan @Column. Halaman itu membaca tipe properti, bukan DataType.