สร้าง 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 ไม่ได้
Mongoose (JS) ถ้า sub-schema อยู่ในตัวแปรแยก ให้ใส่นิยามของมันในอินพุตเดียวกันด้วย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 } }
);{
"_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[subSchema] หรือ [{ name: String }] ได้ _id เว้นแต่ schema ตั้ง { _id: false }type (address: { city: String }) ยังเป็นออบเจ็กต์ธรรมดาที่ไม่มี _idenum ให้ค่าแรก { type: Map, of: String } ให้ {"key": ""} และ Schema.Types.Mixed ให้ nullSchema.Types.ObjectId เป็นสตริง ObjectId ตัวอย่าง และ Decimal128 เป็น {"$numberDecimal": "0"}timestamps: true ยังอ่านการตั้งค่าละเอียดอย่าง { createdAt: "created_at", updatedAt: false } ได้nullเมื่อ README หรือวิกิแสดงเอกสารตัวอย่างของแต่ละคอลเลกชัน การสร้างจากไฟล์ schema ทำให้เอกสารไม่คลาดเคลื่อนไปจากโค้ด
frontend มักเปรียบเทียบรายการในอาร์เรย์โดยไม่รู้ว่าแต่ละรายการมี _id ของตัวเอง ผลลัพธ์ทำให้เห็นชัดว่า _id ปรากฏที่ระดับไหน
ฟิลด์ที่มี ref เป็นแค่สตริง ObjectId จนกว่าจะถูก populate ใช้ผลลัพธ์เป็นจุดอ้างอิงเมื่ออธิบายว่า response เปลี่ยนไปอย่างไรหลัง populate()
default ที่เป็น literal ("active", 0, true) ถูกใช้เป็นค่าตัวอย่าง ค่าเริ่มต้นที่เป็นฟังก์ชันอย่าง Date.now ไม่ถูกรัน ฟิลด์เหล่านั้นจึงได้ค่าตัวอย่างตามไทป์แทนref ยังเป็นสตริง ObjectId ไม่ใช่ออบเจ็กต์ที่ populate แล้วnew Schema({...}, { _id: false }) แบบ inline ที่เขียนเป็นค่าของฟิลด์จะถูกแปลงในที่และเคารพ option ของตัวเอง โดยไม่แสดงเป็นรายการรากแยกtoJSON, getter และ select: false ไม่ถูกนำมาใช้Decimal128 ของ Mongoose serialize ผ่าน toJSON() เป็น {"$numberDecimal": "12.50"} ถ้าคุณส่งเป็นตัวเลขหรือสตริง ให้เพิ่ม getter หรือ transform ใน schema แล้วแก้ผลลัพธ์ให้ตรงกัน
คลาส @Schema() และ interface ให้แปลงที่หน้า Mongoose (TS) to JSON หน้านี้พาร์สออบเจ็กต์ JavaScript ที่ส่งให้ new Schema()
mongoose.model() และ schema อยู่ที่อื่นล่ะ?นิยาม schema ต้องอยู่ในอินพุต ให้วางส่วน new Schema(...) มาด้วย