แปลงสคีมา Mongoose (JS)เป็น JSON!

ป้อนสคีมา Mongoose (JS)เพื่อสร้าง JSON ตัวอย่าง! รองรับ Mongoose new Schema, mongoose.model เหมาะสำหรับเอกสาร API และ request body สำหรับทดสอบ (mock request body)
Mongoose (JS)
ผลลัพธ์
 

แปลงสคีมา Mongoose (JS)เป็น JSON!

สร้าง JSON ตัวอย่างของเอกสารจาก schema ของ Mongoose ที่เขียนด้วย JavaScript ผ่าน new Schema({...}) เพราะเครื่องมือพาร์สตัวออบเจ็กต์นิยาม schema โดยตรง option อย่าง { type: String, enum: [...] } หรือ { type: Map, of: Number } และการอ้างถึงตัวแปร schema อื่นจึงถูกตามไปด้วย

ช่วยได้เมื่อเขียนเอกสารของคอลเลกชันเบื้องหลัง API แบบ Express + Mongoose หรืออธิบายให้ frontend เข้าใจว่าเอกสารหน้าตาเป็นอย่างไร กฎเฉพาะของ Mongoose ก็ถูกนำมาใช้ด้วย เช่น subdocument ในอาร์เรย์ได้ _id แต่ nested path ไม่ได้

วิธีใช้

  1. วางไฟล์ schema ลงในช่อง Mongoose (JS) ถ้า sub-schema อยู่ในตัวแปรแยก ให้ใส่นิยามของมันในอินพุตเดียวกันด้วย
  2. schema ที่ไม่ถูก schema อื่นใช้จะเป็นเอกสารราก ถ้ามีหลายตัว ผลลัพธ์จะใช้ชื่อตัวแปรเป็นคีย์
  3. ตรวจผลลัพธ์แล้วคัดลอกด้วยปุ่มคัดลอก

ตัวอย่าง

อินพุต (Mongoose · JavaScript)
const variantSchema = new Schema({
  sku: String,
  price: Schema.Types.Decimal128,
  stock: { type: Number, default: 0 },
});

const productSchema = new Schema(
  {
    title: { type: String, required: true },
    variants: [variantSchema],
    dimensions: { width: Number, height: Number },
    labels: { type: Map, of: String },
  },
  { timestamps: { createdAt: "created_at", updatedAt: false } }
);
เอาต์พุต (JSON)
{
  "_id": "507f1f77bcf86cd799439011",
  "title": "",
  "variants": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "sku": "",
      "price": {
        "$numberDecimal": "0"
      },
      "stock": 0
    }
  ],
  "dimensions": {
    "width": 0,
    "height": 0
  },
  "labels": {
    "key": ""
  },
  "created_at": "1970-01-01T00:00:00.000Z",
  "__v": 0
}

variants: [variantSchema] เป็นอาร์เรย์ของ subdocument แต่ละรายการจึงได้ _id ขณะที่ __v มีแค่ระดับบนสุด dimensions ไม่มี type จึงเป็น nested path ที่ไม่มี _id และ Decimal128 แสดงในรูปของ toJSON() คือ $numberDecimal option timestamps เปลี่ยนชื่อฟิลด์เป็น created_at และปิด updatedAt จึงเหลือฟิลด์วันที่ฟิลด์เดียว

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

  • เอกสารรากได้ _id และ __v โดยเคารพการเปลี่ยนชื่อด้วย versionKey: "rev" หรือ false
  • subdocument ในอาร์เรย์อย่าง [subSchema] หรือ [{ name: String }] ได้ _id เว้นแต่ schema ตั้ง { _id: false }
  • ออบเจ็กต์ซ้อนที่ไม่มี type (address: { city: String }) ยังเป็นออบเจ็กต์ธรรมดาที่ไม่มี _id
  • อาร์เรย์ enum ให้ค่าแรก { type: Map, of: String } ให้ {"key": ""} และ Schema.Types.Mixed ให้ null
  • Schema.Types.ObjectId เป็นสตริง ObjectId ตัวอย่าง และ Decimal128 เป็น {"$numberDecimal": "0"}
  • นอกจาก timestamps: true ยังอ่านการตั้งค่าละเอียดอย่าง { createdAt: "created_at", updatedAt: false } ได้
  • การอ้างถึงกันเป็นวงระหว่าง schema ถูกตัดด้วย null

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

เอกสารคอลเลกชันที่ถูกต้องเสมอ

เมื่อ README หรือวิกิแสดงเอกสารตัวอย่างของแต่ละคอลเลกชัน การสร้างจากไฟล์ schema ทำให้เอกสารไม่คลาดเคลื่อนไปจากโค้ด

มองเห็น `_id` ของ subdocument

frontend มักเปรียบเทียบรายการในอาร์เรย์โดยไม่รู้ว่าแต่ละรายการมี _id ของตัวเอง ผลลัพธ์ทำให้เห็นชัดว่า _id ปรากฏที่ระดับไหน

อธิบาย response ก่อน populate

ฟิลด์ที่มี ref เป็นแค่สตริง ObjectId จนกว่าจะถูก populate ใช้ผลลัพธ์เป็นจุดอ้างอิงเมื่ออธิบายว่า response เปลี่ยนไปอย่างไรหลัง populate()

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

  • default ที่เป็น literal ("active", 0, true) ถูกใช้เป็นค่าตัวอย่าง ค่าเริ่มต้นที่เป็นฟังก์ชันอย่าง Date.now ไม่ถูกรัน ฟิลด์เหล่านั้นจึงได้ค่าตัวอย่างตามไทป์แทน
  • ฟิลด์ที่มี ref ยังเป็นสตริง ObjectId ไม่ใช่ออบเจ็กต์ที่ populate แล้ว
  • new Schema({...}, { _id: false }) แบบ inline ที่เขียนเป็นค่าของฟิลด์จะถูกแปลงในที่และเคารพ option ของตัวเอง โดยไม่แสดงเป็นรายการรากแยก
  • virtual, transform ของ toJSON, getter และ select: false ไม่ถูกนำมาใช้

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

ทำไมฟิลด์ Decimal128 ออกมาเป็นออบเจ็กต์?

Decimal128 ของ Mongoose serialize ผ่าน toJSON() เป็น {"$numberDecimal": "12.50"} ถ้าคุณส่งเป็นตัวเลขหรือสตริง ให้เพิ่ม getter หรือ transform ใน schema แล้วแก้ผลลัพธ์ให้ตรงกัน

วาง schema ของ TypeScript หรือ NestJS ที่นี่ได้ไหม?

คลาส @Schema() และ interface ให้แปลงที่หน้า Mongoose (TS) to JSON หน้านี้พาร์สออบเจ็กต์ JavaScript ที่ส่งให้ new Schema()

ถ้าในไฟล์มีแค่ mongoose.model() และ schema อยู่ที่อื่นล่ะ?

นิยาม schema ต้องอยู่ในอินพุต ให้วางส่วน new Schema(...) มาด้วย