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

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

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

Подайте классы @Schema(), написанные с @nestjs/mongoose в NestJS, или обычные интерфейсы TypeScript — и получите пример документа в том виде, в каком его выгрузил бы toJSON(). _id, __v и поля временных меток добавляются по собственным правилам Mongoose, даже если класс их не объявляет.

Используйте, чтобы зафиксировать DTO ответов в сервисе на NestJS или договориться с командой о том, как должны выглядеть тестовые документы в коллекции. В отличие от JS-страницы, значения берутся из типов свойств TypeScript, а не из опций @Prop().

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

  1. Вставьте файл с классом схемы в поле Mongoose (TS), включая классы, используемые как поддокументы, чтобы массивы и вложенные объекты были заполнены.
  2. Корнем становится класс, на который никто не ссылается; убедитесь, что в выводе именно ваш основной класс документа.
  3. Меняйте опции вроде @Schema({ timestamps: true, versionKey: false }) и смотрите, как createdAt и __v обновляются в результате.

Пример

Вход (NestJS · @nestjs/mongoose)
@Schema({ _id: false })
export class Attachment {
  @Prop() url: string;
  @Prop() size: number;
}

@Schema({ timestamps: true, versionKey: false })
export class Message {
  @Prop({ type: Types.ObjectId, ref: "Room", required: true })
  roomId: Types.ObjectId;

  @Prop({ required: true })
  text: string;

  @Prop({ type: [Attachment], default: [] })
  attachments: Attachment[];

  @Prop()
  readAt?: Date;
}

export const MessageSchema = SchemaFactory.createForClass(Message);
Результат (JSON)
{
  "_id": "507f1f77bcf86cd799439011",
  "roomId": "507f1f77bcf86cd799439011",
  "text": "",
  "attachments": [
    {
      "url": "",
      "size": 0
    }
  ],
  "readAt": "1970-01-01T00:00:00.000Z",
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z"
}

Message ссылается на Attachment, поэтому корень — Message. _id добавляется в начало, timestamps: true добавляет два поля дат, а versionKey: false убирает __v. roomId с типом Types.ObjectId становится строкой-примером ObjectId.

Возможности

  • Корневой документ получает _id (пример ObjectId 507f1f77bcf86cd799439011) и, если нет versionKey: false, __v: 0; строковый versionKey его переименовывает.
  • @Schema({ timestamps: true }) добавляет createdAt и updatedAt как ISO-строки.
  • Types.ObjectId и MongooseSchema.Types.ObjectId становятся строками ObjectId; Types.Decimal128 и другие числовые типы — 0.
  • Массивы другого класса, например Attachment[], становятся массивом из одного элемента, заполненного по этому классу.
  • Псевдонимы типов вроде type UserDocument = HydratedDocument<User> при выборе корня игнорируются, так что побеждает настоящий класс схемы.
  • Обычные объявления interface без @Schema тоже работают, так что интерфейс модели вроде IUser можно вставить как есть.

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

Ответы NestJS и Swagger

Когда сервис напрямую возвращает this.model.find().lean(), здесь видны точные ключи, которые получают клиенты, включая просачивающиеся в ответ _id и __v.

Тестовые документы для mongosh

Подправьте вывод и передайте его в db.messages.insertOne(), чтобы быстро наполнить локальную базу. Строки ObjectId при этом оберните в ObjectId("...").

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

  • Вложенные классы с декоратором @Schema() считаются поддокументами: они получают собственный _id (если нет @Schema({ _id: false })) и временные метки, но никогда __v. Вложенные классы без @Schema остаются простыми объектами.
  • Литеральный @Prop({ default: ... }) используется как значение примера; опции required и enum не читаются. Для фиксированного набора значений объявите union литералов TypeScript — будет использовано его первое значение.
  • Record<string, any>, объявленный с @Prop({ type: Object }), отображается как {"key": null}.
  • Виртуальные поля, преобразования toJSON и select: false не применяются.

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

Мой API переименовывает _id в id, а в выводе _id.

Вывод следует стандартному toJSON() Mongoose. Если ваша схема добавляет id через toJSON: { virtuals: true } или transform, переименуйте ключ в результате.

Что если тип указан только в опциях, как @Prop({ type: [String] })?

Значения берутся из объявленного типа свойства. С tags: string[] вы получите [""]; если TypeScript-типа нет вовсе, значение неизвестно и становится null.

Можно ли преобразовать здесь JavaScript-схему new Schema({...})?

Для объектов схем на JavaScript используйте страницу Mongoose (JS) в JSON. Она напрямую читает опции схемы вроде { type: String, enum: [...] }.