Bina contoh JSON dokumen daripada skema Mongoose JavaScript yang ditakrifkan dengan new Schema({...}). Oleh sebab objek takrifan skema itu sendiri yang dihuraikan, pilihan seperti { type: String, enum: [...] } atau { type: Map, of: Number } serta rujukan kepada pemboleh ubah skema lain turut diikuti.
Ia berguna semasa mendokumentasikan collection di sebalik API Express + Mongoose, atau menerangkan rupa sesuatu dokumen kepada pasukan frontend. Peraturan khusus Mongoose turut dikekalkan, contohnya subdokumen dalam array mendapat _id manakala nested path tidak.
Mongoose (JS). Jika sub-skema berada dalam pemboleh ubah berasingan, sertakan takrifannya dalam input yang sama.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] ialah array subdokumen, jadi setiap item mendapat _id, manakala __v hanya wujud di peringkat atas. dimensions tiada type, jadi ia nested path tanpa _id, dan Decimal128 dipaparkan dalam bentuk toJSON(), iaitu $numberDecimal. Pilihan timestamps menamakan semula medan kepada created_at dan mematikan updatedAt, lalu hanya tinggal satu medan tarikh.
_id dan __v, dengan mematuhi penamaan semula versionKey: "rev" atau false.[subSchema] atau [{ name: String }] mendapat _id, kecuali skema menetapkan { _id: false }.type (address: { city: String }) kekal sebagai objek biasa tanpa _id.enum memberikan nilai pertamanya, { type: Map, of: String } memberikan {"key": ""}, dan Schema.Types.Mixed memberikan null.Schema.Types.ObjectId menjadi rentetan ObjectId contoh dan Decimal128 menjadi {"$numberDecimal": "0"}.timestamps: true, tetapan terperinci seperti { createdAt: "created_at", updatedAt: false } turut dibaca.null.Apabila README atau wiki memaparkan contoh dokumen bagi setiap collection, menjananya daripada fail skema menghalang dokumentasi daripada tersasar jauh daripada kod.
Frontend kerap membandingkan item array tanpa menyedari setiap satu membawa _id sendiri. Output menunjukkan dengan jelas di peringkat mana _id muncul.
Medan dengan ref hanyalah rentetan ObjectId biasa sehingga di-populate. Gunakan output sebagai asas apabila menerangkan bagaimana respons berubah selepas populate().
default literal ("active", 0, true) digunakan sebagai nilai contoh. Default berbentuk fungsi seperti Date.now tidak dijalankan, jadi medan tersebut mendapat placeholder jenisnya.ref kekal sebagai rentetan ObjectId, bukan objek yang telah di-populate.new Schema({...}, { _id: false }) sebaris yang ditulis sebagai nilai medan ditukar di tempatnya dan mematuhi pilihannya sendiri; ia tidak muncul sebagai entri akar berasingan.toJSON, getter dan select: false tidak diterapkan.Decimal128 Mongoose diserialkan melalui toJSON() sebagai {"$numberDecimal": "12.50"}. Jika anda menghantarnya sebagai nombor atau rentetan, tambah getter atau transform pada skema dan sunting output supaya sepadan.
Tukar kelas @Schema() dan interface di halaman Mongoose (TS) ke JSON. Halaman ini menghurai objek JavaScript yang dihantar kepada new Schema().
mongoose.model() dan skemanya berada di tempat lain?Takrifan skema mesti ada dalam input. Tampal sekali bahagian new Schema(...).