Chuyển schema Mongoose (JS) thành JSON!

Nhập schema Mongoose (JS) để tạo JSON mẫu! Hỗ trợ Mongoose new Schema, mongoose.model. Hữu ích cho tài liệu API và request body thử nghiệm (mock request body).
Mongoose (JS)
Kết quả
 

Chuyển schema Mongoose (JS) thành JSON!

Dựng JSON document mẫu từ schema Mongoose JavaScript được định nghĩa bằng new Schema({...}). Vì chính object định nghĩa schema được parse, các option như { type: String, enum: [...] } hay { type: Map, of: Number } và tham chiếu tới biến schema khác đều được lần theo.

Nó giúp ích khi viết tài liệu cho các collection đứng sau API Express + Mongoose, hoặc giải thích cho frontend một document trông như thế nào. Các quy tắc riêng của Mongoose được giữ nguyên, chẳng hạn subdocument trong mảng có _id còn nested path thì không.

Cách sử dụng

  1. Dán file schema vào ô Mongoose (JS). Nếu sub-schema nằm ở biến riêng, hãy đưa định nghĩa của chúng vào cùng đầu vào.
  2. Schema không được schema nào khác dùng sẽ thành document gốc; nếu có nhiều schema như vậy, output được đặt key theo tên biến.
  3. Xem lại kết quả và sao chép bằng nút sao chép.

Ví dụ

Đầu vào (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 } }
);
Đầu ra (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] là mảng subdocument nên mỗi phần tử có _id, còn __v chỉ có ở cấp cao nhất. dimensions không có type nên là nested path không có _id, và Decimal128 hiện ở dạng toJSON() của nó, $numberDecimal. Option timestamps đổi tên field thành created_at và tắt updatedAt, chỉ còn lại một field ngày.

Tính năng hỗ trợ

  • Document gốc có _id và __v, tôn trọng việc đổi tên versionKey: "rev" hoặc false.
  • Subdocument trong mảng như [subSchema] hay [{ name: String }] có _id, trừ khi schema đặt { _id: false }.
  • Object lồng nhau không có type (address: { city: String }) vẫn là object thuần, không có _id.
  • Mảng enum cho giá trị đầu tiên, { type: Map, of: String } cho {"key": ""}, và Schema.Types.Mixed cho null.
  • Schema.Types.ObjectId thành chuỗi ObjectId mẫu và Decimal128 thành {"$numberDecimal": "0"}.
  • Ngoài timestamps: true, các thiết lập chi tiết như { createdAt: "created_at", updatedAt: false } cũng được đọc.
  • Tham chiếu vòng giữa các schema được cắt bằng null.

Trường hợp sử dụng

Tài liệu collection luôn chính xác

Khi README hay wiki hiển thị document ví dụ cho mỗi collection, tạo nó từ file schema giúp tài liệu không bị lệch khỏi code.

Phát hiện `_id` của subdocument

Frontend thường so sánh các phần tử mảng mà không nhận ra mỗi phần tử mang _id riêng. Output cho thấy rõ _id xuất hiện ở cấp nào.

Giải thích response trước khi populate

Field có ref chỉ là chuỗi ObjectId cho tới khi được populate. Dùng output làm mốc khi mô tả response thay đổi thế nào sau populate().

Lưu ý và giới hạn

  • default dạng literal ("active", 0, true) được dùng làm giá trị mẫu. Default là hàm như Date.now không được chạy, nên các field đó nhận giá trị giữ chỗ theo kiểu.
  • Field có ref vẫn là chuỗi ObjectId chứ không thành object đã populate.
  • new Schema({...}, { _id: false }) viết inline làm giá trị field được chuyển tại chỗ và tôn trọng option riêng của nó; nó không xuất hiện như một mục gốc riêng.
  • Virtual, transform toJSON, getter và select: false không được áp dụng.

Câu hỏi thường gặp

Vì sao field Decimal128 lại ra dạng object?

Decimal128 của Mongoose serialize qua toJSON() thành {"$numberDecimal": "12.50"}. Nếu bạn gửi nó dưới dạng số hoặc chuỗi, hãy thêm getter hoặc transform vào schema và sửa output cho khớp.

Có dán schema TypeScript hay NestJS vào đây được không?

Hãy chuyển class @Schema() và interface trên trang Mongoose (TS) to JSON. Trang này parse object JavaScript được truyền vào new Schema().

Nếu file chỉ có mongoose.model() còn schema nằm ở chỗ khác thì sao?

Định nghĩa schema phải có trong đầu vào. Hãy dán kèm phần new Schema(...).