Tukar skema Mongoose (TS) kepada JSON!

Masukkan skema Mongoose (TS) untuk menjana contoh JSON! Menyokong Mongoose, NestJS @Prop. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Mongoose (TS)
Hasil
 

Tukar skema Mongoose (TS) kepada JSON!

Berikan kelas @Schema() yang ditulis dengan @nestjs/mongoose NestJS, atau interface TypeScript biasa, dan ia menghasilkan contoh dokumen seperti yang dieksport oleh toJSON(). _id, __v dan medan timestamp ditambah mengikut peraturan Mongoose sendiri, walaupun kelas tidak mengisytiharkannya.

Gunakannya untuk memuktamadkan DTO respons dalam servis NestJS, atau untuk bersetuju dengan pasukan tentang rupa dokumen ujian dalam sesuatu collection. Berbeza dengan halaman JS, nilai diambil daripada jenis property TypeScript, bukan daripada pilihan @Prop().

Cara menggunakan

  1. Tampal fail kelas skema ke dalam kotak Mongoose (TS), termasuk kelas yang digunakan sebagai subdokumen supaya array dan objek bersarang turut diisi.
  2. Kelas yang tidak dirujuk oleh kelas lain menjadi akar; pastikan kelas dokumen utama anda ialah yang muncul dalam output.
  3. Ubah pilihan seperti @Schema({ timestamps: true, versionKey: false }) dan lihat createdAt serta __v dikemas kini dalam hasil.

Contoh

Input (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);
Output (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 merujuk Attachment, jadi Message ialah akar. _id diletakkan di hadapan, timestamps: true menambah dua medan tarikh, dan versionKey: false membuang __v. roomId yang berjenis Types.ObjectId menjadi rentetan ObjectId contoh.

Ciri yang disokong

  • Dokumen akar mendapat _id (ObjectId contoh 507f1f77bcf86cd799439011) dan, kecuali versionKey: false, __v: 0; versionKey berbentuk rentetan menamakannya semula.
  • @Schema({ timestamps: true }) menambah createdAt dan updatedAt sebagai rentetan ISO.
  • Types.ObjectId dan MongooseSchema.Types.ObjectId menjadi rentetan ObjectId; Types.Decimal128 dan jenis numerik lain menjadi 0.
  • Array kelas lain, seperti Attachment[], menjadi array satu elemen yang diisi daripada kelas tersebut.
  • Alias jenis seperti type UserDocument = HydratedDocument<User> diabaikan semasa memilih akar, jadi kelas skema sebenar yang dipilih.
  • Pengisytiharan interface biasa tanpa @Schema juga berfungsi, jadi interface model seperti IUser boleh ditampal begitu sahaja.

Kes penggunaan

Respons NestJS dan Swagger

Apabila servis memulangkan this.model.find().lean() secara terus, ini menunjukkan kunci sebenar yang diterima klien, termasuk _id dan __v yang terbocor ke dalam respons.

Dokumen ujian untuk mongosh

Ubah suai output dan hantar kepada db.messages.insertOne() untuk mengisi pangkalan data tempatan dengan cepat. Balut rentetan ObjectId dengan ObjectId("...") apabila berbuat demikian.

Nota dan had

  • Kelas bersarang yang dihias dengan @Schema() dianggap sebagai subdokumen: ia mendapat _id sendiri (kecuali @Schema({ _id: false })) dan timestamp, tetapi tidak sekali-kali __v. Kelas bersarang tanpa @Schema kekal sebagai objek biasa.
  • @Prop({ default: ... }) literal digunakan sebagai nilai contoh; pilihan required dan enum tidak dibaca. Untuk set nilai tetap, isytiharkan literal union TypeScript dan nilai pertamanya akan digunakan.
  • Record<string, any> yang diisytiharkan dengan @Prop({ type: Object }) dipaparkan sebagai {"key": null}.
  • Virtual, transform toJSON dan select: false tidak diterapkan.

Soalan lazim

API saya menamakan semula _id kepada id, tetapi output menunjukkan _id.

Output mengikut toJSON() lalai Mongoose. Jika skema anda menambah id melalui toJSON: { virtuals: true } atau transform, namakan semula kunci itu dalam hasil.

Bagaimana jika jenis hanya ada dalam pilihan, seperti @Prop({ type: [String] })?

Nilai diambil daripada jenis property yang diisytiharkan. Dengan tags: string[] anda mendapat [""]; jika tiada jenis TypeScript langsung, nilainya tidak diketahui dan menjadi null.

Bolehkah saya menukar new Schema({...}) JavaScript di sini?

Gunakan halaman Mongoose (JS) ke JSON untuk objek skema JavaScript. Ia membaca pilihan skema seperti { type: String, enum: [...] } secara terus.