Mongoose (JS) स्कीमा को JSON में बदलें!

Mongoose (JS) स्कीमा डालें और उदाहरण JSON बनाएँ! Mongoose new Schema, mongoose.model समर्थित। API डॉक्यूमेंटेशन और टेस्ट request body (sample JSON) के लिए उपयोगी।
Mongoose (JS)
परिणाम
 

Mongoose (JS) स्कीमा को JSON में बदलें!

new Schema({...}) से define किए JavaScript Mongoose schema से उदाहरण document JSON बनाएं। Schema definition object खुद parse होता है, इसलिए { type: String, enum: [...] } या { type: Map, of: Number } जैसे options और दूसरे schema variables के references का पीछा किया जाता है।

यह Express + Mongoose API के पीछे की collections को document करने, या frontend को यह समझाने में मदद करता है कि document कैसा दिखता है। Mongoose के खास नियम भी लागू रहते हैं, जैसे array subdocuments को _id मिलना जबकि nested paths को नहीं।

उपयोग कैसे करें

  1. Schema फ़ाइल को Mongoose (JS) बॉक्स में पेस्ट करें। अगर sub-schemas अलग variables में हैं, तो उनकी definitions भी उसी इनपुट में शामिल करें।
  2. जिस schema को कोई दूसरा schema इस्तेमाल नहीं करता वह root document बनता है; अगर ऐसे कई हैं, तो आउटपुट variable नाम से keyed होता है।
  3. परिणाम की समीक्षा करें और copy बटन से उसे कॉपी करें।

उदाहरण

इनपुट (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 } }
);
आउटपुट (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
}

variants: [variantSchema] subdocuments का array है, इसलिए हर item को _id मिलता है, जबकि __v सिर्फ़ top level पर है। dimensions में type नहीं है, इसलिए वह बिना _id का nested path है, और Decimal128 अपने toJSON() रूप $numberDecimal में दिखता है। Timestamps option field को created_at नाम देता है और updatedAt बंद करता है, जिससे एक ही date field बचता है।

समर्थित सुविधाएँ

  • Root document को _id और __v मिलते हैं, versionKey: "rev" जैसे renames या false का पालन करते हुए।
  • [subSchema] या [{ name: String }] जैसे array subdocuments को _id मिलता है, जब तक schema { _id: false } सेट न करे।
  • बिना type वाले nested objects (address: { city: String }) बिना _id के सादे objects रहते हैं।
  • enum arrays अपनी पहली वैल्यू देते हैं, { type: Map, of: String } {"key": ""} देता है, और Schema.Types.Mixed null देता है।
  • Schema.Types.ObjectId sample ObjectId string बनता है और Decimal128 {"$numberDecimal": "0"} बनता है।
  • timestamps: true के अलावा { createdAt: "created_at", updatedAt: false } जैसी विस्तृत settings भी पढ़ी जाती हैं।
  • Schemas के बीच circular references null से काट दिए जाते हैं।

उपयोग के मामले

सटीक बने रहने वाले collection docs

जब README या wiki हर collection का उदाहरण document दिखाते हैं, तो उसे schema फ़ाइल से बनाने पर docs कोड से भटकते नहीं।

Subdocument `_id`s पहचानना

Frontends अक्सर array items compare करते हैं बिना यह जाने कि हर एक का अपना _id है। आउटपुट साफ़ दिखाता है कि _id किस स्तर पर आता है।

Populate से पहले के responses समझाना

ref वाले fields populate होने तक सादी ObjectId strings होते हैं। populate() के बाद response कैसे बदलता है, यह बताते समय आउटपुट को आधार के रूप में इस्तेमाल करें।

नोट्स और सीमाएँ

  • Literal default ("active", 0, true) sample वैल्यू के रूप में इस्तेमाल होता है। Date.now जैसे function defaults चलाए नहीं जाते, इसलिए उन fields को type का placeholder मिलता है।
  • ref वाले fields populated objects की बजाय ObjectId strings ही रहते हैं।
  • Field वैल्यू के रूप में लिखा inline new Schema({...}, { _id: false }) अपनी जगह पर बदलता है और अपने options का पालन करता है; वह अलग root entry के रूप में नहीं दिखता।
  • Virtuals, toJSON transforms, getters और select: false लागू नहीं होते।

अक्सर पूछे जाने वाले प्रश्न

Decimal128 field object के रूप में क्यों आता है?

Mongoose का Decimal128 toJSON() से {"$numberDecimal": "12.50"} के रूप में serialize होता है। अगर आप इसे number या string के रूप में भेजते हैं, तो schema में getter या transform जोड़ें और आउटपुट को उसके अनुसार edit करें।

क्या मैं यहां TypeScript या NestJS schemas पेस्ट कर सकता हूं?

@Schema() classes और interfaces को Mongoose (TS) to JSON पेज पर बदलें। यह पेज new Schema() को दिया गया JavaScript object parse करता है।

अगर फ़ाइल में सिर्फ़ mongoose.model() है और schema कहीं और है तो?

Schema definition इनपुट में होनी चाहिए। उसके साथ new Schema(...) वाला हिस्सा भी पेस्ट करें।