Ubah skema Mongoose (JS) menjadi JSON!

Masukkan skema Mongoose (JS) untuk membuat contoh JSON! Mendukung Mongoose new Schema, mongoose.model. Berguna untuk dokumentasi API dan body request uji (mock request body).
Mongoose (JS)
Hasil
 

Ubah skema Mongoose (JS) menjadi JSON!

Bangun contoh JSON dokumen dari schema Mongoose JavaScript yang didefinisikan dengan new Schema({...}). Karena objek definisi schema itu sendiri yang di-parse, opsi seperti { type: String, enum: [...] } atau { type: Map, of: Number } serta referensi ke variabel schema lain ikut ditelusuri.

Berguna saat mendokumentasikan collection di balik API Express + Mongoose, atau menjelaskan ke frontend seperti apa bentuk sebuah dokumen. Aturan khas Mongoose tetap berlaku, misalnya subdokumen dalam array mendapat _id sedangkan nested path tidak.

Cara menggunakan

  1. Tempel file schema ke kolom Mongoose (JS). Jika sub-schema ada di variabel terpisah, sertakan definisinya di input yang sama.
  2. Schema yang tidak dipakai schema lain menjadi dokumen root; jika ada beberapa, output-nya diberi key sesuai nama variabel.
  3. Tinjau hasilnya lalu salin dengan tombol 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] adalah array subdokumen, jadi setiap item mendapat _id, sedangkan __v hanya ada di tingkat atas. dimensions tidak memiliki type, jadi berupa nested path tanpa _id, dan Decimal128 muncul dalam bentuk toJSON()-nya, $numberDecimal. Opsi timestamps mengganti nama field menjadi created_at dan menonaktifkan updatedAt, sehingga hanya tersisa satu field tanggal.

Fitur yang didukung

  • Dokumen root mendapat _id dan __v, dengan memperhatikan penggantian nama versionKey: "rev" atau false.
  • Subdokumen dalam array seperti [subSchema] atau [{ name: String }] mendapat _id, kecuali schema-nya mengatur { _id: false }.
  • Objek bersarang tanpa type (address: { city: String }) tetap 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 string ObjectId contoh dan Decimal128 menjadi {"$numberDecimal": "0"}.
  • Selain timestamps: true, pengaturan rinci seperti { createdAt: "created_at", updatedAt: false } juga dibaca.
  • Referensi melingkar antar-schema dipotong dengan null.

Kasus penggunaan

Dokumentasi collection yang tetap akurat

Ketika README atau wiki menampilkan contoh dokumen per collection, membuatnya dari file schema menjaga dokumentasi agar tidak melenceng dari kode.

Melihat `_id` pada subdokumen

Frontend sering membandingkan item array tanpa menyadari bahwa setiap item membawa _id sendiri. Output memperjelas di level mana _id muncul.

Menjelaskan respons sebelum populate

Field dengan ref berupa string ObjectId biasa sampai di-populate. Gunakan output sebagai acuan saat menjelaskan bagaimana respons berubah setelah populate().

Catatan dan batasan

  • default berupa literal ("active", 0, true) dipakai sebagai nilai contoh. Default berupa fungsi seperti Date.now tidak dijalankan, jadi field tersebut mendapat placeholder tipenya.
  • Field dengan ref tetap berupa string ObjectId, bukan objek yang sudah di-populate.
  • new Schema({...}, { _id: false }) inline yang ditulis sebagai nilai field dikonversi di tempatnya dan mengikuti opsinya sendiri; tidak muncul sebagai entri root terpisah.
  • Virtual, transform toJSON, getter, dan select: false tidak diterapkan.

FAQ

Mengapa field Decimal128 keluar sebagai objek?

Decimal128 milik Mongoose di-serialize lewat toJSON() sebagai {"$numberDecimal": "12.50"}. Jika Anda mengirimnya sebagai number atau string, tambahkan getter atau transform ke schema dan edit output agar sesuai.

Bisakah saya menempel schema TypeScript atau NestJS di sini?

Konversikan class @Schema() dan interface di halaman Mongoose (TS) ke JSON. Halaman ini mem-parse objek JavaScript yang diberikan ke new Schema().

Bagaimana jika file hanya berisi mongoose.model() dan schema-nya ada di tempat lain?

Definisi schema harus ada di input. Tempel juga bagian new Schema(...)-nya.