Dựng JSON document mẫu từ schema Mongoose JavaScript được định nghĩa bằng new Schema({...}). Vì chính object định nghĩa schema được parse, các option như { type: String, enum: [...] } hay { type: Map, of: Number } và tham chiếu tới biến schema khác đều được lần theo.
Nó giúp ích khi viết tài liệu cho các collection đứng sau API Express + Mongoose, hoặc giải thích cho frontend một document trông như thế nào. Các quy tắc riêng của Mongoose được giữ nguyên, chẳng hạn subdocument trong mảng có _id còn nested path thì không.
Mongoose (JS). Nếu sub-schema nằm ở biến riêng, hãy đưa định nghĩa của chúng vào cùng đầu vào.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] là mảng subdocument nên mỗi phần tử có _id, còn __v chỉ có ở cấp cao nhất. dimensions không có type nên là nested path không có _id, và Decimal128 hiện ở dạng toJSON() của nó, $numberDecimal. Option timestamps đổi tên field thành created_at và tắt updatedAt, chỉ còn lại một field ngày.
_id và __v, tôn trọng việc đổi tên versionKey: "rev" hoặc false.[subSchema] hay [{ name: String }] có _id, trừ khi schema đặt { _id: false }.type (address: { city: String }) vẫn là object thuần, không có _id.enum cho giá trị đầu tiên, { type: Map, of: String } cho {"key": ""}, và Schema.Types.Mixed cho null.Schema.Types.ObjectId thành chuỗi ObjectId mẫu và Decimal128 thành {"$numberDecimal": "0"}.timestamps: true, các thiết lập chi tiết như { createdAt: "created_at", updatedAt: false } cũng được đọc.null.Khi README hay wiki hiển thị document ví dụ cho mỗi collection, tạo nó từ file schema giúp tài liệu không bị lệch khỏi code.
Frontend thường so sánh các phần tử mảng mà không nhận ra mỗi phần tử mang _id riêng. Output cho thấy rõ _id xuất hiện ở cấp nào.
Field có ref chỉ là chuỗi ObjectId cho tới khi được populate. Dùng output làm mốc khi mô tả response thay đổi thế nào sau populate().
default dạng literal ("active", 0, true) được dùng làm giá trị mẫu. Default là hàm như Date.now không được chạy, nên các field đó nhận giá trị giữ chỗ theo kiểu.ref vẫn là chuỗi ObjectId chứ không thành object đã populate.new Schema({...}, { _id: false }) viết inline làm giá trị field được chuyển tại chỗ và tôn trọng option riêng của nó; nó không xuất hiện như một mục gốc riêng.toJSON, getter và select: false không được áp dụng.Decimal128 của Mongoose serialize qua toJSON() thành {"$numberDecimal": "12.50"}. Nếu bạn gửi nó dưới dạng số hoặc chuỗi, hãy thêm getter hoặc transform vào schema và sửa output cho khớp.
Hãy chuyển class @Schema() và interface trên trang Mongoose (TS) to JSON. Trang này parse object JavaScript được truyền vào new Schema().
mongoose.model() còn schema nằm ở chỗ khác thì sao?Định nghĩa schema phải có trong đầu vào. Hãy dán kèm phần new Schema(...).