Tukar skema Mongoose (JS) kepada JSON!

Masukkan skema Mongoose (JS) untuk menjana contoh JSON! Menyokong Mongoose new Schema, mongoose.model. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Mongoose (JS)
Hasil
 

Tukar skema Mongoose (JS) kepada JSON!

Bina contoh JSON dokumen daripada skema Mongoose JavaScript yang ditakrifkan dengan new Schema({...}). Oleh sebab objek takrifan skema itu sendiri yang dihuraikan, pilihan seperti { type: String, enum: [...] } atau { type: Map, of: Number } serta rujukan kepada pemboleh ubah skema lain turut diikuti.

Ia berguna semasa mendokumentasikan collection di sebalik API Express + Mongoose, atau menerangkan rupa sesuatu dokumen kepada pasukan frontend. Peraturan khusus Mongoose turut dikekalkan, contohnya subdokumen dalam array mendapat _id manakala nested path tidak.

Cara menggunakan

  1. Tampal fail skema ke dalam kotak Mongoose (JS). Jika sub-skema berada dalam pemboleh ubah berasingan, sertakan takrifannya dalam input yang sama.
  2. Skema yang tidak digunakan oleh skema lain menjadi dokumen akar; jika ada beberapa, output dikunci mengikut nama pemboleh ubah.
  3. Semak hasilnya dan salin dengan butang salin.

Contoh

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
}

variants: [variantSchema] ialah array subdokumen, jadi setiap item mendapat _id, manakala __v hanya wujud di peringkat atas. dimensions tiada type, jadi ia nested path tanpa _id, dan Decimal128 dipaparkan dalam bentuk toJSON(), iaitu $numberDecimal. Pilihan timestamps menamakan semula medan kepada created_at dan mematikan updatedAt, lalu hanya tinggal satu medan tarikh.

Ciri yang disokong

  • Dokumen akar mendapat _id dan __v, dengan mematuhi penamaan semula versionKey: "rev" atau false.
  • Subdokumen array seperti [subSchema] atau [{ name: String }] mendapat _id, kecuali skema menetapkan { _id: false }.
  • Objek bersarang tanpa type (address: { city: String }) kekal sebagai objek biasa tanpa _id.
  • Array enum memberikan nilai pertamanya, { type: Map, of: String } memberikan {"key": ""}, dan Schema.Types.Mixed memberikan null.
  • Schema.Types.ObjectId menjadi rentetan ObjectId contoh dan Decimal128 menjadi {"$numberDecimal": "0"}.
  • Selain timestamps: true, tetapan terperinci seperti { createdAt: "created_at", updatedAt: false } turut dibaca.
  • Rujukan bulat antara skema diputuskan dengan null.

Kes penggunaan

Dokumentasi collection yang sentiasa tepat

Apabila README atau wiki memaparkan contoh dokumen bagi setiap collection, menjananya daripada fail skema menghalang dokumentasi daripada tersasar jauh daripada kod.

Mengesan `_id` subdokumen

Frontend kerap membandingkan item array tanpa menyedari setiap satu membawa _id sendiri. Output menunjukkan dengan jelas di peringkat mana _id muncul.

Menerangkan respons sebelum populate

Medan dengan ref hanyalah rentetan ObjectId biasa sehingga di-populate. Gunakan output sebagai asas apabila menerangkan bagaimana respons berubah selepas populate().

Nota dan had

  • default literal ("active", 0, true) digunakan sebagai nilai contoh. Default berbentuk fungsi seperti Date.now tidak dijalankan, jadi medan tersebut mendapat placeholder jenisnya.
  • Medan dengan ref kekal sebagai rentetan ObjectId, bukan objek yang telah di-populate.
  • new Schema({...}, { _id: false }) sebaris yang ditulis sebagai nilai medan ditukar di tempatnya dan mematuhi pilihannya sendiri; ia tidak muncul sebagai entri akar berasingan.
  • Virtual, transform toJSON, getter dan select: false tidak diterapkan.

Soalan lazim

Kenapa medan Decimal128 keluar sebagai objek?

Decimal128 Mongoose diserialkan melalui toJSON() sebagai {"$numberDecimal": "12.50"}. Jika anda menghantarnya sebagai nombor atau rentetan, tambah getter atau transform pada skema dan sunting output supaya sepadan.

Bolehkah saya tampal skema TypeScript atau NestJS di sini?

Tukar kelas @Schema() dan interface di halaman Mongoose (TS) ke JSON. Halaman ini menghurai objek JavaScript yang dihantar kepada new Schema().

Bagaimana jika fail hanya mengandungi mongoose.model() dan skemanya berada di tempat lain?

Takrifan skema mesti ada dalam input. Tampal sekali bahagian new Schema(...).