แปลงสคีมา Mongoose (TS)เป็น JSON!

ป้อนสคีมา Mongoose (TS)เพื่อสร้าง JSON ตัวอย่าง! รองรับ Mongoose, NestJS @Prop เหมาะสำหรับเอกสาร API และ request body สำหรับทดสอบ (mock request body)
Mongoose (TS)
ผลลัพธ์
 

แปลงสคีมา Mongoose (TS)เป็น JSON!

ใส่คลาส @Schema() ที่เขียนด้วย @nestjs/mongoose ของ NestJS หรือ interface ของ TypeScript ธรรมดา แล้วจะได้ตัวอย่างเอกสารในรูปที่ toJSON() จะส่งออก _id, __v และฟิลด์ timestamp ถูกเพิ่มตามกฎของ Mongoose เอง แม้คลาสจะไม่ได้ประกาศไว้

ใช้เพื่อกำหนด response DTO ในเซอร์วิส NestJS ให้ชัด หรือตกลงกับทีมว่าเอกสารทดสอบในคอลเลกชันควรหน้าตาแบบไหน ต่างจากหน้า JS ตรงที่ค่าถูกนำมาจากไทป์ของพร็อพเพอร์ตีใน TypeScript ไม่ใช่จาก option ของ @Prop()

วิธีใช้

  1. วางไฟล์คลาส schema ลงในช่อง Mongoose (TS) โดยรวมคลาสที่ใช้เป็น subdocument ด้วย เพื่อให้อาร์เรย์และออบเจ็กต์ซ้อนถูกเติมค่า
  2. คลาสที่ไม่มีใครอ้างถึงจะเป็นราก ตรวจให้แน่ใจว่าคลาสเอกสารหลักของคุณคือตัวที่อยู่ในผลลัพธ์
  3. เปลี่ยน option อย่าง @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) และ __v: 0 เว้นแต่มี versionKey: false ถ้า versionKey เป็นสตริงจะใช้เป็นชื่อใหม่
  • @Schema({ timestamps: true }) ต่อท้าย createdAt และ updatedAt เป็นสตริง ISO
  • Types.ObjectId และ MongooseSchema.Types.ObjectId เป็นสตริง ObjectId ส่วน Types.Decimal128 และไทป์ตัวเลขอื่นเป็น 0
  • อาร์เรย์ของคลาสอื่นอย่าง Attachment[] กลายเป็นอาร์เรย์หนึ่งสมาชิกที่เติมค่าจากคลาสนั้น
  • type alias อย่าง type UserDocument = HydratedDocument<User> ถูกข้ามตอนเลือกราก คลาส schema ตัวจริงจึงถูกเลือก
  • การประกาศ interface ธรรมดาที่ไม่มี @Schema ก็ใช้ได้ interface ของโมเดลอย่าง IUser จึงวางได้ตามที่เป็นอยู่

กรณีการใช้งาน

response ของ NestJS และ Swagger

เมื่อเซอร์วิสคืน this.model.find().lean() โดยตรง ผลลัพธ์นี้แสดงคีย์ที่ไคลเอนต์ได้รับจริง รวมถึง _id และ __v ที่หลุดไปใน response

เอกสารทดสอบสำหรับ mongosh

ปรับผลลัพธ์แล้วส่งให้ db.messages.insertOne() เพื่อใส่ข้อมูลลงฐานข้อมูลบนเครื่องได้อย่างรวดเร็ว อย่าลืมครอบสตริง ObjectId ด้วย ObjectId("...")

ข้อควรระวังและข้อจำกัด

  • คลาสซ้อนที่ติด @Schema() ถือเป็น subdocument: ได้ _id ของตัวเอง (เว้นแต่ @Schema({ _id: false })) และ timestamp แต่ไม่ได้ __v คลาสซ้อนที่ไม่มี @Schema ยังเป็นออบเจ็กต์ธรรมดา
  • @Prop({ default: ... }) ที่เป็น literal ถูกใช้เป็นค่าตัวอย่าง แต่ไม่อ่าน option required และ enum ถ้ามีชุดค่าตายตัว ให้ประกาศเป็น literal union ของ TypeScript แล้วค่าแรกจะถูกใช้
  • Record<string, any> ที่ประกาศด้วย @Prop({ type: Object }) แสดงเป็น {"key": null}
  • virtual, transform ของ toJSON และ select: false ไม่ถูกนำมาใช้

คำถามที่พบบ่อย

API ของฉันเปลี่ยนชื่อ _id เป็น id แต่ผลลัพธ์แสดง _id

ผลลัพธ์ทำตาม toJSON() ค่าเริ่มต้นของ Mongoose ถ้า schema เพิ่ม id ผ่าน toJSON: { virtuals: true } หรือ transform ให้เปลี่ยนชื่อคีย์ในผลลัพธ์เอง

ถ้าไทป์อยู่แค่ใน option อย่าง @Prop({ type: [String] }) ล่ะ?

ค่ามาจากไทป์ที่ประกาศของพร็อพเพอร์ตี ถ้าเป็น tags: string[] จะได้ [""] ถ้าไม่มีไทป์ TypeScript เลย จะไม่รู้ค่าและกลายเป็น null

แปลง new Schema({...}) ของ JavaScript ที่นี่ได้ไหม?

ออบเจ็กต์ schema ของ JavaScript ให้ใช้หน้า Mongoose (JS) to JSON ซึ่งอ่าน option ของ schema อย่าง { type: String, enum: [...] } ได้โดยตรง