Tukar model Sequelize (TS) kepada JSON!

Masukkan model Sequelize (TS) untuk menjana contoh JSON! Menyokong Sequelize, sequelize-typescript. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Sequelize (TS)
Hasil
 

Tukar model Sequelize (TS) kepada JSON!

Berikan kelas model @Table yang ditulis dengan sequelize-typescript dan ia membina contoh JSON mengikut bentuk output toJSON() instance. Ini termasuk atribut id, createdAt, updatedAt dan deletedAt yang ditambah oleh Sequelize walaupun tidak diisytiharkan dalam kelas.

Berbeza dengan halaman JS, nilai di sini diambil daripada jenis TypeScript setiap property, bukan daripada argumen DataType. @Column(DataType.DECIMAL) yang diisytiharkan sebagai amount: string menghasilkan rentetan.

Cara menggunakan

  1. Tampal fail yang mengandungi kelas @Table ke dalam kotak Sequelize (TS). Tambah model yang berkaitan (melalui @HasMany dan seumpamanya) untuk mendapatkan nilai bersarang.
  2. Semak kotak Hasil untuk JSON bersama atribut yang ditambah secara automatik.
  3. Tukar pilihan @Table seperti timestamps atau paranoid untuk melihat serta-merta bagaimana medan tarikh berubah.

Contoh

Input (sequelize-typescript)
@Table({ tableName: "invoices", paranoid: true })
export class Invoice extends Model {
  @Column(DataType.STRING(20))
  number: string;

  @Column(DataType.DECIMAL(10, 2))
  amount: string;

  @Column(DataType.ENUM("draft", "sent", "paid"))
  status: "draft" | "sent" | "paid";

  @ForeignKey(() => Customer)
  @Column
  customerId: number;
}
Output (JSON)
{
  "id": 0,
  "number": "",
  "amount": "",
  "status": "draft",
  "customerId": 0,
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "deletedAt": null
}

Kelas ini tiada primary key, jadi id ditambah di hadapan, dan paranoid: true menambah deletedAt: null. status mengambil literal pertama dalam union, "draft", dan amount ialah rentetan kosong kerana ia diisytiharkan sebagai string.

Ciri yang disokong

  • Tanpa @PrimaryKey, @Column({ primaryKey: true }) atau property id, id: 0 disisipkan di bahagian atas, sama ada bagi akar mahupun model yang berkaitan.
  • Kecuali @Table menetapkan timestamps: false, createdAt dan updatedAt ditambah di hujung; penamaan semula seperti createdAt: "created_on", updatedAt: false dan paranoid: true (deletedAt: null) dipatuhi bagi setiap model.
  • Post[] daripada @HasMany menjadi array; @BelongsTo dan @HasOne menjadi objek bersarang.
  • Literal union seperti "draft" | "sent" menggunakan nilai pertama, dan semua yang diwarisi melalui extends Model diabaikan.
  • Lajur DataType.JSON yang berjenis objek, contohnya { theme: string }, diisi mengikut bentuk tersebut.

Kes penggunaan

Mendokumentasikan handler Express

Bagi endpoint yang melakukan res.json(await Invoice.findByPk(id)), output memberikan contoh respons dengan kunci yang sepadan dengan realiti, termasuk atribut yang ditambah secara automatik.

Sebelum dan selepas mengaktifkan soft delete

Menghidupkan paranoid menambah deletedAt pada setiap respons. Bandingkan output dengan pilihan itu dihidupkan dan dimatikan untuk memberitahu pengguna API dengan tepat apa yang akan berubah.

Nota dan had

  • Model berkaitan yang bersarang dalam akar mendapat id dan timestamp sendiri berdasarkan pilihan @Table masing-masing, tetapi foreign key yang ditambah secara tersirat oleh Sequelize (seperti invoiceId pada sasaran @HasMany tanpa lajur @ForeignKey) tidak direka-reka.
  • allowNull dan penamaan semula lajur melalui @Column({ field: ... }) diabaikan, kerana kunci JSON ialah nama property. @Default("x") dan defaultValue literal dalam @Column({...}) digunakan sebagai nilai contoh.
  • underscored: true hanya menukar nama lajur pangkalan data; toJSON() masih menggunakan nama atribut, jadi createdAt dalam output adalah betul.
  • Nilai diambil daripada jenis TypeScript, jadi property yang jenisnya hanya diberikan melalui decorator (@Column(DataType.INTEGER) count; tanpa anotasi) menjadi null.

Soalan lazim

Patutkah lajur DECIMAL diberi jenis number atau string?

Dengan MySQL dan PostgreSQL, Sequelize memulangkan nilai DECIMAL sebagai rentetan secara lalai. Memberi jenis amount: string memastikan jenisnya jujur, dan contoh di sini juga akan menunjukkan rentetan.

Bolehkah saya menggunakan medan declare atau CreationOptional?

Boleh. declare id: CreationOptional<number> dibaca sebagai number, dan pembukaan yang sama diterapkan pada NonAttribute<...> dan ForeignKey<...>. Jenis pembantu selain itu, seperti InferAttributes, tidak dikembangkan.

Adakah halaman ini mengendalikan model sequelize.define yang ditulis dalam JavaScript?

Tidak. Halaman ini membaca kelas dan jenis TypeScript. Gunakan halaman Sequelize (JS) ke JSON untuk model define dan Model.init, yang membaca DataTypes sebaliknya.