Monta um JSON de documento de exemplo a partir de um schema Mongoose em JavaScript definido com new Schema({...}). Como é feito o parse do próprio objeto de definição do schema, opções como { type: String, enum: [...] } ou { type: Map, of: Number } e referências a outras variáveis de schema são seguidas.
Ajuda ao documentar as collections por trás de uma API Express + Mongoose, ou ao explicar para o frontend como é um documento. Regras específicas do Mongoose são mantidas, como subdocumentos em array ganharem _id enquanto paths aninhados não ganham.
Mongoose (JS). Se os sub-schemas estão em variáveis separadas, inclua as definições deles na mesma 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] é um array de subdocumentos, então cada item ganha _id, enquanto __v só existe no nível mais alto. dimensions não tem type, então é um path aninhado sem _id, e o Decimal128 aparece na forma do seu toJSON(), $numberDecimal. A opção timestamps renomeia o campo para created_at e desativa o updatedAt, deixando um único campo de data.
_id e __v, respeitando renomeações com versionKey: "rev" ou false.[subSchema] ou [{ name: String }] recebem _id, a menos que o schema defina { _id: false }.type (address: { city: String }) continuam objetos simples, sem _id.enum dão o seu primeiro valor, { type: Map, of: String } dá {"key": ""} e Schema.Types.Mixed dá null.Schema.Types.ObjectId vira uma string ObjectId de exemplo e Decimal128 vira {"$numberDecimal": "0"}.timestamps: true, configurações detalhadas como { createdAt: "created_at", updatedAt: false } são lidas.null.Quando um README ou wiki mostra um documento de exemplo por collection, gerá-lo a partir do arquivo de schema evita que a documentação se afaste do código.
O frontend muitas vezes compara itens de array sem perceber que cada um carrega o seu próprio _id. A saída deixa claro em qual nível o _id aparece.
Campos com ref são strings ObjectId simples até passarem por populate. Use a saída como base ao descrever como uma resposta muda depois do populate().
default literal ("active", 0, true) é usado como valor de exemplo. Defaults de função como Date.now não são executados, então esses campos recebem o placeholder do tipo.ref continuam strings ObjectId em vez de objetos populados.new Schema({...}, { _id: false }) inline escrito como valor de campo é convertido no lugar e respeita as próprias opções; ele não aparece como entrada raiz separada.toJSON, getters e select: false não são aplicados.O Decimal128 do Mongoose é serializado pelo toJSON() como {"$numberDecimal": "12.50"}. Se você manda como número ou string, adicione um getter ou transform no schema e edite a saída para bater.
Converta classes @Schema() e interfaces na página Mongoose (TS) para JSON. Esta página faz o parse do objeto JavaScript passado para new Schema().
mongoose.model() e o schema estiver em outro lugar?A definição do schema precisa estar na entrada. Cole a parte do new Schema(...) junto.