Chuyển model Sequelize (TS) thành JSON!

Nhập model Sequelize (TS) để tạo JSON mẫu! Hỗ trợ Sequelize, sequelize-typescript. Hữu ích cho tài liệu API và request body thử nghiệm (mock request body).
Sequelize (TS)
Kết quả
 

Chuyển model Sequelize (TS) thành JSON!

Đưa vào các class model @Table viết bằng sequelize-typescript, công cụ dựng JSON ví dụ có hình dạng giống output toJSON() của instance. Trong đó có cả các attribute id, createdAt, updatedAt và deletedAt mà Sequelize tự thêm kể cả khi chúng không được khai báo trong class.

Khác với trang JS, giá trị ở đây đến từ kiểu TypeScript của mỗi property chứ không phải tham số DataType. @Column(DataType.DECIMAL) khai báo là amount: string sẽ cho ra chuỗi.

Cách sử dụng

  1. Dán file chứa các class @Table vào ô Sequelize (TS). Thêm các model có quan hệ (qua @HasMany và tương tự) để có giá trị lồng nhau.
  2. Kiểm tra JSON kèm các attribute tự thêm trong ô Kết quả.
  3. Bật tắt các option của @Table như timestamps hay paranoid để thấy ngay các field ngày thay đổi thế nào.

Ví dụ

Đầu vào (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;
}
Đầu ra (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
}

Class không có khóa chính nên id được thêm vào đầu, và paranoid: true thêm deletedAt: null. status lấy literal đầu tiên trong union của nó, "draft", còn amount là chuỗi rỗng vì được khai báo là string.

Tính năng hỗ trợ

  • Khi không có @PrimaryKey, @Column({ primaryKey: true }) hay property id, id: 0 được chèn ở đầu, cho cả model gốc lẫn model có quan hệ.
  • Trừ khi @Table đặt timestamps: false, createdAt và updatedAt được nối thêm; việc đổi tên như createdAt: "created_on", updatedAt: false và paranoid: true (deletedAt: null) được tôn trọng theo từng model.
  • Post[] từ @HasMany thành mảng; @BelongsTo và @HasOne thành object lồng nhau.
  • Literal union như "draft" | "sent" dùng giá trị đầu tiên, và mọi thứ kế thừa qua extends Model bị bỏ qua.
  • Cột DataType.JSON có kiểu object, ví dụ { theme: string }, được điền theo đúng hình dạng đó.

Trường hợp sử dụng

Viết tài liệu cho handler Express

Với endpoint làm res.json(await Invoice.findByPk(id)), output cho ra ví dụ response có key khớp thực tế, kể cả các attribute tự thêm.

Trước và sau khi bật soft delete

Bật paranoid sẽ thêm deletedAt vào mọi response. So sánh output khi bật và tắt option để báo cho bên dùng API chính xác điều gì sẽ thay đổi.

Lưu ý và giới hạn

  • Model có quan hệ lồng trong gốc nhận id và timestamp riêng theo option @Table của chính nó, nhưng khóa ngoại mà Sequelize ngầm thêm (như invoiceId trên đích của @HasMany không có cột @ForeignKey) không được tự bịa ra.
  • allowNull và việc đổi tên cột qua @Column({ field: ... }) bị bỏ qua, vì key JSON là tên property. @Default("x") và defaultValue dạng literal trong @Column({...}) được dùng làm giá trị mẫu.
  • underscored: true chỉ đổi tên cột database; toJSON() vẫn dùng tên attribute, nên createdAt trong output là đúng.
  • Giá trị lấy từ kiểu TypeScript, nên property chỉ có kiểu qua decorator (@Column(DataType.INTEGER) count; không có annotation) thành null.

Câu hỏi thường gặp

Cột DECIMAL nên khai báo kiểu number hay string?

Với MySQL và PostgreSQL, Sequelize mặc định trả giá trị DECIMAL dưới dạng chuỗi. Khai báo amount: string giữ cho kiểu trung thực, và ví dụ ở đây cũng sẽ hiện chuỗi.

Có dùng được field declare hay CreationOptional không?

Được. declare id: CreationOptional<number> được đọc là number, và cách mở bọc tương tự áp dụng cho NonAttribute<...> và ForeignKey<...>. Các helper type ngoài những cái này, như InferAttributes, không được mở rộng.

Trang này có xử lý model sequelize.define viết bằng JavaScript không?

Không. Trang này đọc class và kiểu TypeScript. Hãy dùng trang Sequelize (JS) to JSON cho model define và Model.init, trang đó đọc DataTypes.