Tukar model Sequelize (JS) kepada JSON!

Masukkan model Sequelize (JS) untuk menjana contoh JSON! Menyokong Sequelize define, DataTypes. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Sequelize (JS)
Hasil
 

Tukar model Sequelize (JS) kepada JSON!

Alat ini membaca model Sequelize yang ditulis dalam JavaScript biasa, sequelize.define("User", {...}) atau Model.init({...}, {...}), dan menukarnya kepada contoh JSON. Oleh sebab tiada anotasi jenis untuk dijadikan panduan, nilai setiap atribut dipilih berdasarkan entri DataTypesnya.

Ia sesuai untuk pelayan Node.js lama yang menjalankan Express dan Sequelize tanpa TypeScript, di mana fail model ialah satu-satunya gambaran tentang rupa respons API atau baris seed.

Cara menggunakan

  1. Tampal fail model ke dalam kotak Sequelize (JS). Baris require dan module.exports yang tertinggal tidak menjadi masalah.
  2. Jika fail mentakrifkan beberapa model, output dikunci mengikut nama model, contohnya { "User": {...}, "Post": {...} }.
  3. Pastikan pilihan model (argumen kedua) seperti timestamps, paranoid atau createdAt yang dinamakan semula telah diambil kira, kemudian 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 mempunyai primaryKey: true, jadi id tidak ditambah, dan defaultValuenya ialah DataTypes.UUIDV4, iaitu penjana dan bukan literal, jadi UUID placeholder dipaparkan. updatedAt: false menjadikan createdAt satu-satunya timestamp, dan DATEONLY, TIME, JSONB serta ARRAY(STRING) masing-masing menjadi rentetan tarikh, rentetan masa, objek kosong dan array satu elemen.

Ciri yang disokong

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • DATE memberikan 1970-01-01T00:00:00.000Z, DATEONLY memberikan 1970-01-01 dan TIME memberikan 00:00:00.
  • UUID menjadi rentetan UUID serba sifar, ENUM("admin", "user") menjadi nilai pertamanya, dan JSON/JSONB menjadi objek kosong.
  • ARRAY(DataTypes.STRING) mengikut jenis elemennya, dan VIRTUAL(DataTypes.STRING) diisi daripada jenis dalamannya.
  • Pilihan model timestamps: false, updatedAt: false, createdAt: "created_on" dan paranoid: true menambah, membuang atau menamakan semula atribut tarikh.
  • Kedua-dua bentuk panjang { type: ..., allowNull: ... } dan bentuk ringkas DataTypes.X difahami.

Kes penggunaan

Mendraf data seeder

Mulakan daripada output semasa menulis array objek untuk queryInterface.bulkInsert, supaya nama kunci dan jenis sepadan dengan model. Buang id dan timestamp yang dijana jika pangkalan data yang mengisinya.

Membaca kod legacy tanpa jenis

Tanpa TypeScript, sukar untuk mengetahui JSON yang dihantar oleh sesuatu model hanya dengan membacanya. Memproses setiap fail model di sini memberikan peta ringkas bentuk respons API.

Nota dan had

  • defaultValue literal ("pending", 1, true) menjadi nilai contoh. Default yang dijana seperti DataTypes.NOW, DataTypes.UUIDV4 atau sequelize.fn(...) kembali kepada placeholder jenis tersebut.
  • Association seperti hasMany dan belongsTo berada di luar takrifan model, jadi ia tiada dalam output. Tambah sendiri data yang anda muatkan dengan include.
  • Pada MySQL dan PostgreSQL, DECIMAL biasanya dipulangkan sebagai rentetan semasa runtime, tetapi contoh ini menunjukkan 0.
  • Jenis tanpa nilai contoh yang jelas, seperti GEOMETRY, menjadi null.

Soalan lazim

Saya tetapkan underscored: true. Kenapa ia createdAt dan bukan created_at?

underscored hanya menukar nama lajur pangkalan data kepada snake_case. Nama atribut yang digunakan oleh toJSON() kekal createdAt, jadi output adalah betul. Untuk menukar kunci JSON juga, namakannya secara eksplisit dengan createdAt: "created_at".

Adakah ia berfungsi apabila class User extends Model {} dan User.init() dipisahkan?

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

Di mana saya menukar model decorator TypeScript?

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