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

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

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

Công cụ này đọc model Sequelize viết bằng JavaScript thuần, sequelize.define("User", {...}) hoặc Model.init({...}, {...}), rồi biến chúng thành JSON ví dụ. Vì không có type annotation để dựa vào, giá trị của mỗi attribute được chọn theo mục DataTypes của nó.

Nó phù hợp với các server Node.js cũ chạy Express và Sequelize không có TypeScript, nơi file model là mô tả duy nhất về hình dạng của response API hay dòng seed.

Cách sử dụng

  1. Dán file model vào ô Sequelize (JS). Các dòng require và module.exports còn sót lại không sao cả.
  2. Nếu file định nghĩa nhiều model, output được đặt key theo tên model, ví dụ { "User": {...}, "Post": {...} }.
  3. Kiểm tra các option của model (tham số thứ hai) như timestamps, paranoid hay createdAt bị đổi tên đã được phản ánh, rồi sao chép.

Ví dụ

Đầu vào (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 }
);
Đầu ra (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 có primaryKey: true nên không thêm id, và defaultValue của nó là DataTypes.UUIDV4, một bộ sinh chứ không phải literal, nên UUID giữ chỗ được hiển thị. updatedAt: false chỉ để lại createdAt là timestamp duy nhất, và DATEONLY, TIME, JSONB cùng ARRAY(STRING) thành chuỗi ngày, chuỗi giờ, object rỗng và mảng một phần tử.

Tính năng hỗ trợ

  • DataTypes.STRING, TEXT, CHAR → ""; INTEGER, BIGINT, FLOAT, DECIMAL → 0; BOOLEAN → false.
  • DATE cho 1970-01-01T00:00:00.000Z, DATEONLY cho 1970-01-01 và TIME cho 00:00:00.
  • UUID thành chuỗi UUID toàn số 0, ENUM("admin", "user") thành giá trị đầu tiên, và JSON/JSONB thành object rỗng.
  • ARRAY(DataTypes.STRING) theo kiểu phần tử của nó, và VIRTUAL(DataTypes.STRING) được điền từ kiểu bên trong.
  • Option của model timestamps: false, updatedAt: false, createdAt: "created_on" và paranoid: true thêm, bỏ hoặc đổi tên các attribute ngày.
  • Hiểu cả dạng dài { type: ..., allowNull: ... } lẫn dạng ngắn DataTypes.X.

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

Soạn dữ liệu cho seeder

Bắt đầu từ output khi viết mảng object cho queryInterface.bulkInsert, để tên key và kiểu khớp với model. Bỏ id và timestamp được tạo ở những chỗ database tự điền.

Đọc code legacy không có kiểu

Không có TypeScript thì chỉ đọc model rất khó biết nó gửi ra JSON gì. Chạy từng file model qua đây cho bạn nhanh chóng bức tranh về hình dạng response của API.

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

  • defaultValue dạng literal ("pending", 1, true) thành giá trị mẫu. Mặc định được sinh ra như DataTypes.NOW, DataTypes.UUIDV4 hay sequelize.fn(...) quay về giá trị giữ chỗ của kiểu.
  • Quan hệ như hasMany và belongsTo nằm ngoài định nghĩa model nên không có trong output. Hãy tự thêm dữ liệu mà bạn nạp bằng include.
  • Trên MySQL và PostgreSQL, DECIMAL lúc runtime thường trả về dạng chuỗi, nhưng ví dụ hiển thị 0.
  • Kiểu không có giá trị mẫu hiển nhiên, như GEOMETRY, thành null.

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

Tôi đặt underscored: true. Sao vẫn là createdAt chứ không phải created_at?

underscored chỉ đổi tên cột database sang snake_case. Tên attribute mà toJSON() dùng vẫn là createdAt, nên output khớp với thực tế. Để đổi cả key JSON, hãy đặt tên tường minh bằng createdAt: "created_at".

Có chạy được khi class User extends Model {} và User.init() tách rời nhau không?

Được. Định danh ngay trước .init( được dùng làm tên model, và tham số đầu tiên được đọc làm bảng attribute.

Model dùng decorator TypeScript thì chuyển ở đâu?

Hãy dùng trang Sequelize (TS) to JSON cho model sequelize-typescript có @Table và @Column. Trang đó đọc kiểu của property thay vì DataType.