将 Mongoose (JS) 模式 转换为 JSON!

输入 Mongoose (JS) 模式,即可生成示例 JSON!支持 Mongoose new Schema, mongoose.model。适用于 API 文档和测试请求体(sample JSON)。
Mongoose (JS)
结果
 

将 Mongoose (JS) 模式 转换为 JSON!

根据用 new Schema({...}) 定义的 JavaScript Mongoose schema 生成示例文档 JSON。由于解析的是 schema 定义对象本身,{ type: String, enum: [...] }、{ type: Map, of: Number } 这样的选项以及对其他 schema 变量的引用都会被跟踪。

为 Express + Mongoose API 背后的集合编写文档,或者向前端解释文档长什么样时,它都能帮上忙。Mongoose 特有的规则也会照搬过来,比如数组中的子文档有 _id,而嵌套路径没有。

使用方法

  1. 把 schema 文件粘贴到 Mongoose (JS) 框中。如果子 schema 定义在单独的变量里,请把它们的定义放进同一个输入。
  2. 没有被其他 schema 使用的 schema 会成为根文档;如果有多个,输出会以变量名为 key。
  3. 检查结果,然后用复制按钮复制。

示例

输入 (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] 是子文档数组,所以每一项都有 _id,而 __v 只出现在顶层。dimensions 没有 type,因此是不带 _id 的嵌套路径;Decimal128 以它的 toJSON() 形式 $numberDecimal 出现。timestamps 选项把字段重命名为 created_at 并关闭了 updatedAt,只剩下一个日期字段。

支持的功能

  • 根文档会得到 _id 和 __v,并遵循 versionKey: "rev" 这样的重命名或 false。
  • [subSchema] 或 [{ name: String }] 这样的数组子文档会得到 _id,除非 schema 设置了 { _id: false }。
  • 没有 type 的嵌套对象(address: { city: String })保持为普通对象,不带 _id。
  • enum 数组取第一个值,{ type: Map, of: String } 得到 {"key": ""},Schema.Types.Mixed 得到 null。
  • Schema.Types.ObjectId 变成示例 ObjectId 字符串,Decimal128 变成 {"$numberDecimal": "0"}。
  • 除了 timestamps: true,{ createdAt: "created_at", updatedAt: false } 这样的详细设置也会被读取。
  • schema 之间的循环引用会用 null 截断。

使用场景

始终准确的集合文档

当 README 或 wiki 为每个集合展示示例文档时,从 schema 文件生成示例可以防止文档与代码渐行渐远。

发现子文档的 `_id`

前端在比较数组元素时,常常没意识到每一项都带着自己的 _id。输出清楚地显示了 _id 出现在哪一层。

说明 populate 之前的响应

带 ref 的字段在 populate 之前只是 ObjectId 字符串。描述 populate() 之后响应如何变化时,可以把输出作为基准。

注意事项与限制

  • 字面量形式的 default("active"、0、true)会用作示例值。Date.now 这样的函数默认值不会被执行,因此这些字段会改用该类型的占位值。
  • 带 ref 的字段保持为 ObjectId 字符串,而不是 populate 后的对象。
  • 作为字段值内联写出的 new Schema({...}, { _id: false }) 会就地转换并遵循自身的选项,不会作为单独的根条目出现。
  • 不应用 virtual、toJSON 转换、getter 和 select: false。

常见问题

为什么 Decimal128 字段输出成了对象?

Mongoose 的 Decimal128 通过 toJSON() 序列化为 {"$numberDecimal": "12.50"}。如果你以数字或字符串形式发送,请在 schema 中添加 getter 或 transform,并相应修改输出。

可以在这里粘贴 TypeScript 或 NestJS 的 schema 吗?

@Schema() 类和接口请在 Mongoose (TS) 转 JSON 页面转换。本页解析的是传给 new Schema() 的 JavaScript 对象。

如果文件里只有 mongoose.model(),schema 在别处怎么办?

输入中必须包含 schema 定义。请把 new Schema(...) 部分一起粘贴进来。