Construisez un document JSON d'exemple à partir d'un schéma Mongoose JavaScript défini avec new Schema({...}). Comme l'objet de définition du schéma lui-même est analysé, les options comme { type: String, enum: [...] } ou { type: Map, of: Number } et les références à d'autres variables de schéma sont suivies.
Utile pour documenter les collections derrière une API Express + Mongoose, ou pour expliquer au frontend à quoi ressemble un document. Les règles propres à Mongoose sont respectées, par exemple les sous-documents de tableau qui reçoivent un _id contrairement aux chemins imbriqués.
Mongoose (JS). Si des sous-schémas sont dans des variables séparées, incluez leurs définitions dans la même entrée.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] est un tableau de sous-documents : chaque élément reçoit donc _id, alors que __v n'existe qu'au niveau racine. dimensions n'a pas de type : c'est un chemin imbriqué sans _id, et Decimal128 apparaît sous sa forme toJSON(), $numberDecimal. L'option timestamps renomme le champ en created_at et désactive updatedAt, ce qui ne laisse qu'un seul champ de date.
_id et __v, en respectant un renommage versionKey: "rev" ou false.[subSchema] ou [{ name: String }] reçoivent _id, sauf si le schéma définit { _id: false }.type (address: { city: String }) restent des objets simples sans _id.enum donnent leur première valeur, { type: Map, of: String } donne {"key": ""}, et Schema.Types.Mixed donne null.Schema.Types.ObjectId devient une chaîne ObjectId d'exemple et Decimal128 devient {"$numberDecimal": "0"}.timestamps: true, les réglages détaillés comme { createdAt: "created_at", updatedAt: false } sont lus.null.Quand un README ou un wiki montre un document d'exemple par collection, le générer à partir du fichier de schéma empêche la doc de s'éloigner du code.
Le frontend compare souvent des éléments de tableau sans savoir que chacun porte son propre _id. La sortie montre clairement à quel niveau _id apparaît.
Les champs avec ref sont de simples chaînes ObjectId tant qu'ils ne sont pas peuplés. Servez-vous de la sortie comme référence pour décrire comment une réponse change après populate().
default littéral ("active", 0, true) sert de valeur d'exemple. Les valeurs par défaut fonctions comme Date.now ne sont pas exécutées : ces champs reçoivent la valeur générique du type.ref restent des chaînes ObjectId plutôt que des objets peuplés.new Schema({...}, { _id: false }) inline écrit comme valeur de champ est converti sur place en respectant ses propres options ; il n'apparaît pas comme une entrée racine séparée.toJSON, les getters et select: false ne sont pas appliqués.Le Decimal128 de Mongoose est sérialisé via toJSON() en {"$numberDecimal": "12.50"}. Si vous l'envoyez comme nombre ou chaîne, ajoutez un getter ou une transformation au schéma et modifiez la sortie en conséquence.
Convertissez les classes @Schema() et les interfaces sur la page Mongoose (TS) vers JSON. Cette page analyse l'objet JavaScript passé à new Schema().
mongoose.model() et que le schéma est ailleurs ?La définition du schéma doit figurer dans l'entrée. Collez aussi la partie new Schema(...).