I-convert ang mga Mongoose (JS) schema sa JSON!

Maglagay ng mga Mongoose (JS) schema para gumawa ng halimbawang JSON! Sinusuportahan ang Mongoose new Schema, mongoose.model. Magagamit sa API docs at test request body (mock request body).
Mongoose (JS)
Resulta
 

I-convert ang mga Mongoose (JS) schema sa JSON!

Bumuo ng halimbawang document JSON mula sa isang JavaScript Mongoose schema na dine-define gamit ang new Schema({...}). Dahil mismong schema definition object ang pina-parse, sinusundan ang mga option gaya ng { type: String, enum: [...] } o { type: Map, of: Number } at ang mga reference sa ibang schema variable.

Nakakatulong ito sa pagdodokumento ng mga collection sa likod ng isang Express + Mongoose API, o sa pagpapaliwanag sa frontend kung ano ang itsura ng isang document. Nadadala ang mga rule na partikular sa Mongoose, gaya ng pagkakaroon ng _id ng mga array subdocument habang wala nito ang mga nested path.

Paano gamitin

  1. I-paste ang schema file sa Mongoose (JS) box. Kung nasa magkakahiwalay na variable ang mga sub-schema, isama ang mga definition nila sa parehong input.
  2. Ang schema na hindi ginagamit ng ibang schema ang nagiging root document; kung marami, naka-key sa variable name ang output.
  3. I-review ang resulta at kopyahin ito gamit ang copy button.

Halimbawa

Input (Mongoose · JavaScript)
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 } }
);
Output (JSON)
{
  "_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
}

Array ng mga subdocument ang variants: [variantSchema], kaya may _id ang bawat item, habang nasa top level lang ang __v. Walang type ang dimensions, kaya nested path ito na walang _id, at lumalabas ang Decimal128 sa anyong toJSON() nito, $numberDecimal. Pinapalitan ng timestamps option ang pangalan ng field sa created_at at dina-disable ang updatedAt, kaya iisang date field ang natitira.

Mga sinusuportahang feature

  • May _id at __v ang root document, at sinusunod ang pagpapalit ng pangalan gamit ang versionKey: "rev" o ang false.
  • May _id ang mga array subdocument gaya ng [subSchema] o [{ name: String }], maliban kung nag-set ang schema ng { _id: false }.
  • Nananatiling simpleng object na walang _id ang mga nested object na walang type (address: { city: String }).
  • Ibinibigay ng mga enum array ang una nilang value, {"key": ""} ang mula sa { type: Map, of: String }, at null ang mula sa Schema.Types.Mixed.
  • Nagiging sample ObjectId string ang Schema.Types.ObjectId at nagiging {"$numberDecimal": "0"} ang Decimal128.
  • Bukod sa timestamps: true, binabasa rin ang mga detalyadong setting gaya ng { createdAt: "created_at", updatedAt: false }.
  • Pinuputol gamit ang null ang mga circular reference sa pagitan ng mga schema.

Mga gamit

Collection docs na nananatiling tama

Kapag nagpapakita ang isang README o wiki ng halimbawang document bawat collection, sa pag-generate nito mula sa schema file, hindi lumalayo ang docs sa code.

Pagpansin sa `_id` ng mga subdocument

Madalas ikumpara ng mga frontend ang mga array item nang hindi napapansing may sariling _id ang bawat isa. Malinaw sa output kung saang level lumalabas ang _id.

Pagpapaliwanag ng mga response bago ang populate

Simpleng ObjectId string ang mga field na may ref hangga't hindi pa napo-populate. Gamitin ang output bilang baseline kapag inilalarawan kung paano nagbabago ang isang response pagkatapos ng populate().

Mga paalala at limitasyon

  • Ginagamit bilang sample value ang literal na default ("active", 0, true). Hindi pinapatakbo ang mga function default gaya ng Date.now, kaya placeholder ng type ang nakukuha ng mga field na iyon.
  • Nananatiling ObjectId string ang mga field na may ref sa halip na mga napopulate na object.
  • Kino-convert sa puwesto ang inline na new Schema({...}, { _id: false }) na isinulat bilang field value at sinusunod nito ang sarili nitong mga option; hindi ito lumalabas bilang hiwalay na root entry.
  • Hindi ina-apply ang mga virtual, toJSON transform, getter at select: false.

Mga madalas itanong

Bakit lumalabas na object ang isang Decimal128 field?

Sine-serialize ang Decimal128 ng Mongoose sa pamamagitan ng toJSON() bilang {"$numberDecimal": "12.50"}. Kung ipinapadala mo ito bilang numero o string, magdagdag ng getter o transform sa schema at i-edit ang output para tumugma.

Puwede ba akong mag-paste rito ng TypeScript o NestJS schema?

I-convert ang mga @Schema() class at interface sa page na Mongoose (TS) to JSON. Ang JavaScript object na ipinapasa sa new Schema() ang pina-parse ng page na ito.

Paano kung mongoose.model() lang ang nasa file at nasa ibang lugar ang schema?

Dapat nasa input ang schema definition. I-paste rin ang bahaging new Schema(...).