Преобразуйте схемы Mongoose (JS) в JSON!

Введите схемы Mongoose (JS), чтобы получить пример JSON! Поддержка: Mongoose new Schema, mongoose.model. Удобно для документации API и тестовых тел запросов (mock request body).
Mongoose (JS)
Результат
 

Преобразуйте схемы Mongoose (JS) в JSON!

Строит пример JSON-документа по схеме Mongoose на JavaScript, определённой через new Schema({...}). Поскольку разбирается сам объект определения схемы, отслеживаются опции вроде { type: String, enum: [...] } или { type: Map, of: Number } и ссылки на другие переменные со схемами.

Помогает документировать коллекции за API на Express + Mongoose или объяснять фронтенду, как выглядит документ. Специфичные для Mongoose правила сохраняются: например, поддокументы в массивах получают _id, а вложенные пути — нет.

Как пользоваться

  1. Вставьте файл схемы в поле Mongoose (JS). Если подсхемы лежат в отдельных переменных, включите их определения в тот же ввод.
  2. Корневым документом становится схема, которую не использует ни одна другая схема; если таких несколько, вывод разбивается по именам переменных.
  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, если схема не задаёт { _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 }.
  • Циклические ссылки между схемами обрываются на null.

Сценарии использования

Документация коллекций, которая не устаревает

Когда README или вики показывает пример документа для каждой коллекции, генерация из файла схемы не даёт документации разойтись с кодом.

Где появляются `_id` поддокументов

Фронтенд часто сравнивает элементы массивов, не подозревая, что у каждого есть собственный _id. Вывод наглядно показывает, на каком уровне появляется _id.

Объяснение ответов до populate

Поля с ref — это просто строки ObjectId, пока не выполнен populate. Используйте вывод как базу, объясняя, как меняется ответ после populate().

Примечания и ограничения

  • Литеральный default ("active", 0, true) используется как значение примера. Функции по умолчанию вроде Date.now не выполняются, так что такие поля получают заглушку по типу.
  • Поля с ref остаются строками ObjectId, а не заполненными объектами.
  • Встроенная new Schema({...}, { _id: false }), записанная как значение поля, преобразуется на месте с учётом собственных опций; отдельной корневой записью она не появляется.
  • Виртуальные поля, преобразования toJSON, геттеры и select: false не применяются.

Частые вопросы

Почему поле Decimal128 выводится объектом?

Decimal128 в Mongoose сериализуется через toJSON() как {"$numberDecimal": "12.50"}. Если вы отдаёте его числом или строкой, добавьте в схему геттер или transform и поправьте вывод соответственно.

Можно ли вставить сюда схемы на TypeScript или NestJS?

Классы @Schema() и интерфейсы преобразуйте на странице Mongoose (TS) в JSON. Эта страница разбирает JavaScript-объект, передаваемый в new Schema().

Что если в файле только mongoose.model(), а схема в другом месте?

Определение схемы должно быть во вводе. Вставьте часть с new Schema(...) вместе с ним.