Erzeuge Beispiel-JSON eines Dokuments aus einem JavaScript-Mongoose-Schema, das mit new Schema({...}) definiert ist. Da das Definitionsobjekt des Schemas selbst geparst wird, werden Optionen wie { type: String, enum: [...] } oder { type: Map, of: Number } sowie Verweise auf andere Schema-Variablen verfolgt.
Das hilft beim Dokumentieren der Collections hinter einer Express-+-Mongoose-API oder wenn du dem Frontend erklärst, wie ein Dokument aussieht. Mongoose-spezifische Regeln werden übernommen, etwa dass Subdokumente in Arrays ein _id bekommen, verschachtelte Pfade aber nicht.
Mongoose (JS) ein. Liegen Sub-Schemas in eigenen Variablen, nimm ihre Definitionen in dieselbe Eingabe auf.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] ist ein Array von Subdokumenten, daher bekommt jedes Element ein _id, während __v nur auf oberster Ebene existiert. dimensions hat kein type und ist daher ein verschachtelter Pfad ohne _id, und Decimal128 erscheint in seiner toJSON()-Form, $numberDecimal. Die Timestamps-Option benennt das Feld in created_at um und deaktiviert updatedAt, sodass ein einziges Datumsfeld übrig bleibt.
_id und __v und beachtet Umbenennungen per versionKey: "rev" oder false.[subSchema] oder [{ name: String }] bekommen ein _id, es sei denn, das Schema setzt { _id: false }.type (address: { city: String }) bleiben einfache Objekte ohne _id.enum-Arrays liefern ihren ersten Wert, { type: Map, of: String } ergibt {"key": ""}, und Schema.Types.Mixed ergibt null.Schema.Types.ObjectId wird zu einem Beispiel-ObjectId-String und Decimal128 zu {"$numberDecimal": "0"}.timestamps: true hinaus werden auch detaillierte Einstellungen wie { createdAt: "created_at", updatedAt: false } gelesen.null abgeschnitten.Zeigt eine README oder ein Wiki ein Beispieldokument pro Collection, verhindert das Erzeugen aus der Schemadatei, dass sich die Doku vom Code entfernt.
Frontends vergleichen Array-Elemente oft, ohne zu bemerken, dass jedes ein eigenes _id trägt. Die Ausgabe macht deutlich, auf welcher Ebene _id auftaucht.
Felder mit ref sind bis zum Populate einfache ObjectId-Strings. Nimm die Ausgabe als Ausgangspunkt, wenn du beschreibst, wie sich eine Antwort nach populate() verändert.
default ("active", 0, true) dient als Beispielwert. Funktions-Standardwerte wie Date.now werden nicht ausgeführt, diese Felder bekommen stattdessen den Platzhalter des Typs.ref bleiben ObjectId-Strings statt aufgelöster Objekte.new Schema({...}, { _id: false }) wird an Ort und Stelle umgewandelt und beachtet seine eigenen Optionen; es erscheint nicht als eigener Wurzeleintrag.toJSON-Transforms, Getter und select: false werden nicht angewendet.Decimal128 von Mongoose serialisiert über toJSON() als {"$numberDecimal": "12.50"}. Sendest du es als Zahl oder String, ergänze am Schema einen Getter oder Transform und passe die Ausgabe entsprechend an.
@Schema()-Klassen und Interfaces wandelst du auf der Seite Mongoose (TS) zu JSON um. Diese Seite parst das JavaScript-Objekt, das an new Schema() übergeben wird.
mongoose.model() steht und das Schema woanders liegt?Die Schemadefinition muss in der Eingabe stehen. Füge den Teil new Schema(...) mit ein.