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

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

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

Đưa vào các class @Schema() viết bằng @nestjs/mongoose của NestJS, hoặc interface TypeScript thuần, công cụ sẽ tạo ví dụ document đúng như khi toJSON() xuất ra. _id, __v và các field timestamp được thêm theo đúng quy tắc của Mongoose, kể cả khi class không khai báo chúng.

Dùng nó để chốt DTO response trong service NestJS, hoặc để thống nhất với đội về hình dạng của document thử nghiệm trong một collection. Khác với trang JS, giá trị được lấy từ kiểu property TypeScript chứ không phải từ option của @Prop().

Cách sử dụng

  1. Dán file class schema vào ô Mongoose (TS), kể cả các class được dùng làm subdocument để mảng và object lồng nhau được điền giá trị.
  2. Class không bị class nào khác tham chiếu sẽ thành gốc; hãy chắc chắn class document chính của bạn là cái xuất hiện trong output.
  3. Đổi option như @Schema({ timestamps: true, versionKey: false }) và xem createdAt và __v cập nhật trong kết quả.

Ví dụ

Đầu vào (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);
Đầu ra (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 tham chiếu Attachment, nên Message là gốc. _id được thêm vào đầu, timestamps: true thêm hai field ngày, và versionKey: false bỏ __v. roomId, có kiểu Types.ObjectId, thành chuỗi ObjectId mẫu.

Tính năng hỗ trợ

  • Document gốc có _id (ObjectId mẫu 507f1f77bcf86cd799439011) và, trừ khi versionKey: false, có __v: 0; versionKey dạng chuỗi sẽ đổi tên nó.
  • @Schema({ timestamps: true }) nối thêm createdAt và updatedAt dưới dạng chuỗi ISO.
  • Types.ObjectId và MongooseSchema.Types.ObjectId thành chuỗi ObjectId; Types.Decimal128 và các kiểu số khác thành 0.
  • Mảng của class khác, như Attachment[], thành mảng một phần tử được điền từ class đó.
  • Type alias như type UserDocument = HydratedDocument<User> bị bỏ qua khi chọn gốc, nên class schema thật được ưu tiên.
  • Khai báo interface thuần không có @Schema cũng dùng được, nên interface model như IUser có thể dán nguyên trạng.

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

Response của NestJS và Swagger

Khi service trả thẳng this.model.find().lean(), công cụ cho thấy chính xác các key mà client nhận được, kể cả _id và __v bị lọt vào response.

Document thử nghiệm cho mongosh

Chỉnh output rồi truyền vào db.messages.insertOne() để seed nhanh database cục bộ. Khi đó hãy bọc chuỗi ObjectId trong ObjectId("...").

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

  • Class lồng nhau có decorator @Schema() được coi là subdocument: chúng có _id riêng (trừ khi @Schema({ _id: false })) và timestamp, nhưng không bao giờ có __v. Class lồng nhau không có @Schema vẫn là object thuần.
  • @Prop({ default: ... }) dạng literal được dùng làm giá trị mẫu; option required và enum không được đọc. Với tập giá trị cố định, hãy khai báo literal union của TypeScript và giá trị đầu tiên sẽ được dùng.
  • Record<string, any> khai báo bằng @Prop({ type: Object }) hiện thành {"key": null}.
  • Virtual, transform toJSON và select: false không được áp dụng.

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

API của tôi đổi _id thành id, nhưng output lại hiện _id.

Output theo toJSON() mặc định của Mongoose. Nếu schema thêm id qua toJSON: { virtuals: true } hoặc một transform, hãy đổi tên key trong kết quả.

Nếu kiểu chỉ nằm trong option, như @Prop({ type: [String] }), thì sao?

Giá trị lấy từ kiểu đã khai báo của property. Với tags: string[] bạn nhận [""]; nếu hoàn toàn không có kiểu TypeScript, giá trị không xác định và thành null.

Có chuyển new Schema({...}) JavaScript ở đây được không?

Hãy dùng trang Mongoose (JS) to JSON cho object schema JavaScript. Trang đó đọc trực tiếp các option của schema như { type: String, enum: [...] }.