แปลงโมเดล Sequelize (JS)เป็น JSON!

ป้อนโมเดล Sequelize (JS)เพื่อสร้าง JSON ตัวอย่าง! รองรับ Sequelize define, DataTypes เหมาะสำหรับเอกสาร API และ request body สำหรับทดสอบ (mock request body)
Sequelize (JS)
ผลลัพธ์
 

แปลงโมเดล Sequelize (JS)เป็น JSON!

เครื่องมือนี้อ่านโมเดล Sequelize ที่เขียนด้วย JavaScript ล้วน ทั้ง sequelize.define("User", {...}) และ Model.init({...}, {...}) แล้วแปลงเป็น JSON ตัวอย่าง เมื่อไม่มี type annotation ให้อ้างอิง ค่าของแต่ละ attribute จึงถูกเลือกจาก DataTypes ของมัน

เหมาะกับเซิร์ฟเวอร์ Node.js รุ่นเก่าที่รัน Express และ Sequelize โดยไม่มี TypeScript ซึ่งไฟล์โมเดลเป็นสิ่งเดียวที่บอกว่า response ของ API หรือแถว seed หน้าตาเป็นอย่างไร

วิธีใช้

  1. วางไฟล์โมเดลลงในช่อง Sequelize (JS) ไม่ต้องลบบรรทัด require หรือ module.exports ที่ค้างอยู่
  2. ถ้าไฟล์นิยามหลายโมเดล ผลลัพธ์จะใช้ชื่อโมเดลเป็นคีย์ เช่น { "User": {...}, "Post": {...} }
  3. ตรวจว่า option ของโมเดล (อาร์กิวเมนต์ตัวที่สอง) อย่าง timestamps, paranoid หรือ createdAt ที่เปลี่ยนชื่อถูกสะท้อนแล้ว จากนั้นคัดลอก

ตัวอย่าง

อินพุต (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 }
);
เอาต์พุต (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 มี primaryKey: true จึงไม่มีการเพิ่ม id และ defaultValue ของมันคือ DataTypes.UUIDV4 ซึ่งเป็นตัวสร้างค่า ไม่ใช่ literal จึงแสดง UUID ตัวอย่าง updatedAt: false ทำให้เหลือ createdAt เป็น timestamp เดียว ส่วน DATEONLY, TIME, JSONB และ ARRAY(STRING) กลายเป็นสตริงวันที่ สตริงเวลา ออบเจ็กต์ว่าง และอาร์เรย์หนึ่งสมาชิก

ฟีเจอร์ที่รองรับ

  • DataTypes.STRING, TEXT, CHAR → "", INTEGER, BIGINT, FLOAT, DECIMAL → 0, BOOLEAN → false
  • DATE ให้ 1970-01-01T00:00:00.000Z, DATEONLY ให้ 1970-01-01 และ TIME ให้ 00:00:00
  • UUID เป็นสตริง UUID ที่เป็นศูนย์ทั้งหมด ENUM("admin", "user") เป็นค่าแรก และ JSON/JSONB เป็นออบเจ็กต์ว่าง
  • ARRAY(DataTypes.STRING) ตามไทป์ของสมาชิก และ VIRTUAL(DataTypes.STRING) ถูกเติมจากไทป์ข้างใน
  • option ของโมเดล timestamps: false, updatedAt: false, createdAt: "created_on" และ paranoid: true จะเพิ่ม ตัด หรือเปลี่ยนชื่อ attribute วันที่
  • เข้าใจทั้งรูปแบบเต็ม { type: ..., allowNull: ... } และรูปแบบย่อ DataTypes.X

กรณีการใช้งาน

ร่างข้อมูลสำหรับ seeder

เริ่มจากผลลัพธ์เมื่อเขียนอาร์เรย์ออบเจ็กต์สำหรับ queryInterface.bulkInsert ชื่อคีย์และไทป์จะตรงกับโมเดล ลบ id และ timestamp ที่สร้างขึ้นออกในกรณีที่ฐานข้อมูลเติมให้เอง

อ่านโค้ด legacy ที่ไม่มีไทป์

ถ้าไม่มี TypeScript การอ่านโมเดลอย่างเดียวยากจะบอกได้ว่าส่ง JSON แบบไหน การนำไฟล์โมเดลแต่ละไฟล์มาผ่านที่นี่ทำให้เห็นภาพรวมรูปร่าง response ของ API ได้เร็ว

ข้อควรระวังและข้อจำกัด

  • defaultValue ที่เป็น literal ("pending", 1, true) กลายเป็นค่าตัวอย่าง ค่าเริ่มต้นที่สร้างขึ้นอย่าง DataTypes.NOW, DataTypes.UUIDV4 หรือ sequelize.fn(...) จะใช้ค่าตัวอย่างตามไทป์แทน
  • association อย่าง hasMany และ belongsTo อยู่นอกนิยามโมเดล จึงไม่อยู่ในผลลัพธ์ ข้อมูลที่โหลดด้วย include ต้องเพิ่มเอง
  • บน MySQL และ PostgreSQL DECIMAL มักกลับมาเป็นสตริงตอนรัน แต่ตัวอย่างแสดงเป็น 0
  • ไทป์ที่ไม่มีค่าตัวอย่างที่ชัดเจนอย่าง GEOMETRY จะเป็น null

คำถามที่พบบ่อย

ตั้ง underscored: true ไว้ ทำไมยังเป็น createdAt ไม่ใช่ created_at?

underscored เปลี่ยนแค่ชื่อคอลัมน์ในฐานข้อมูลเป็น snake_case ชื่อ attribute ที่ toJSON() ใช้ยังเป็น createdAt ผลลัพธ์จึงตรงกัน ถ้าต้องการเปลี่ยนคีย์ JSON ด้วย ให้ตั้งชื่อชัดเจนด้วย createdAt: "created_at"

ใช้ได้ไหมถ้า class User extends Model {} กับ User.init() แยกกัน?

ได้ identifier ที่อยู่ก่อน .init( ถูกใช้เป็นชื่อโมเดล และอาร์กิวเมนต์แรกถูกอ่านเป็น map ของ attribute

โมเดลแบบ decorator ของ TypeScript แปลงที่ไหน?

โมเดล sequelize-typescript ที่มี @Table และ @Column ให้ใช้หน้า Sequelize (TS) to JSON ซึ่งอ่านไทป์ของพร็อพเพอร์ตีแทน DataType