Construye un JSON de documento de ejemplo a partir de un schema de Mongoose en JavaScript definido con new Schema({...}). Como se parsea el propio objeto de definición del schema, se siguen opciones como { type: String, enum: [...] } o { type: Map, of: Number } y las referencias a otras variables de schema.
Ayuda a documentar las colecciones que hay detrás de una API Express + Mongoose, o a explicar al frontend cómo es un documento. Se mantienen las reglas propias de Mongoose, como que los subdocumentos de arrays reciben _id mientras que las rutas anidadas no.
Mongoose (JS). Si los subschemas están en variables separadas, incluye sus definiciones en la misma entrada.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] es un array de subdocumentos, así que cada elemento recibe _id, mientras que __v solo existe en el nivel superior. dimensions no tiene type, así que es una ruta anidada sin _id, y Decimal128 aparece en su forma toJSON(), $numberDecimal. La opción timestamps renombra el campo a created_at y desactiva updatedAt, dejando un solo campo de fecha.
_id y __v, respetando los renombrados versionKey: "rev" o false.[subSchema] o [{ name: String }] reciben _id, salvo que el schema configure { _id: false }.type (address: { city: String }) se quedan como objetos simples sin _id.enum dan su primer valor, { type: Map, of: String } da {"key": ""} y Schema.Types.Mixed da null.Schema.Types.ObjectId pasa a una cadena ObjectId de ejemplo y Decimal128 a {"$numberDecimal": "0"}.timestamps: true, se leen configuraciones detalladas como { createdAt: "created_at", updatedAt: false }.null.Cuando un README o una wiki muestra un documento de ejemplo por colección, generarlo a partir del archivo de schema evita que la documentación se aleje del código.
Los frontends a menudo comparan elementos de arrays sin darse cuenta de que cada uno lleva su propio _id. La salida deja claro en qué nivel aparece _id.
Los campos con ref son cadenas ObjectId simples hasta que se hace populate. Usa la salida como referencia al describir cómo cambia una respuesta después de populate().
default literal ("active", 0, true) se usa como valor de ejemplo. Los defaults que son funciones, como Date.now, no se ejecutan, así que esos campos reciben el placeholder del tipo.ref se quedan como cadenas ObjectId en lugar de objetos con populate.new Schema({...}, { _id: false }) en línea escrito como valor de un campo se convierte en su sitio y respeta sus propias opciones; no aparece como una entrada raíz aparte.toJSON, los getters ni select: false.El Decimal128 de Mongoose se serializa mediante toJSON() como {"$numberDecimal": "12.50"}. Si lo envías como número o cadena, añade un getter o una transformación al schema y edita la salida para que coincida.
Convierte las clases @Schema() y las interfaces en la página Mongoose (TS) a JSON. Esta página parsea el objeto JavaScript que se pasa a new Schema().
mongoose.model() y el schema está en otro sitio?La definición del schema tiene que estar en la entrada. Pega también la parte new Schema(...).