วางคลาส entity ของ TypeORM แล้วจะได้รูปร่าง JSON ที่ entity เหล่านั้นสร้างเมื่อคืนจาก API โดยเติมค่าตัวอย่างไว้ ออกแบบมาสำหรับโปรเจกต์ NestJS หรือ Express ที่ส่ง entity กลับใน response โดยตรง และต้องการตัวอย่างสำหรับ Swagger หรือตัวอย่าง request/response ไว้ตกลงกับ frontend
ค่ามาจากไทป์ TypeScript ของแต่ละพร็อพเพอร์ตี ไม่ใช่จาก option ของ @Column คอลัมน์ที่ประกาศ @Column({ type: "decimal" }) คู่กับ price: number จึงออกมาเป็นตัวเลข 0
TypeORM ใส่ entity ที่สัมพันธ์กันและ enum ไว้ด้วย เพื่อให้ออบเจ็กต์ซ้อนถูกเติมค่าผลลัพธ์ อัปเดตตามที่พิมพ์ entity ที่ไม่มี entity อื่นอ้างถึงจะเป็นออบเจ็กต์ JSON ระดับบนสุด ถ้ามีหลาย entity ที่ไม่เกี่ยวข้องกัน แต่ละตัวจะอยู่ใต้ชื่อคลาสของมันenum Genre { Novel = "novel", Essay = "essay" }
@Entity()
export class Author {
@PrimaryGeneratedColumn()
id: number;
@Column()
name: string;
}
@Entity()
export class Book {
@PrimaryGeneratedColumn("uuid")
id: string;
@Column({ type: "enum", enum: Genre })
genre: Genre;
@Column({ type: "decimal", nullable: true })
price: number | null;
@ManyToOne(() => Author)
author: Author;
@Exclude()
@Column()
internalCode: string;
}{
"id": "",
"genre": "novel",
"price": 0,
"author": {
"id": 0,
"name": ""
}
}Book อ้างถึง Author ดังนั้น Book จึงเป็นราก และ author ซ้อนอยู่ข้างใน internalCode ถูกตัดออกเพราะ @Exclude() และ price ที่มีไทป์ number | null ใช้ไทป์แรกที่ไม่ใช่ null จึงกลายเป็น 0 primary key แบบ uuid มีไทป์ string จึงเป็นสตริงว่าง
@ManyToOne และ @OneToOne กลายเป็นออบเจ็กต์ซ้อน Post[] จาก @OneToMany หรือ @ManyToMany กลายเป็นอาร์เรย์หนึ่งสมาชิกPromise<Post[]>) และ wrapper Relation<User> ของ ESM ถูกแกะเป็นไทป์ข้างใน@Exclude() ของ class-transformer ฟิลด์ static เมธอด และ getter ถูกตัดออกDate (จาก @CreateDateColumn และที่คล้ายกัน) กลายเป็นสตริง ISO อย่าง 1970-01-01T00:00:00.000ZRecord<string, number> แสดงเป็น {"key": 0}null หรืออาร์เรย์ว่าง เพื่อให้การซ้อนมีจุดสิ้นสุดcontroller ที่คืน entity โดยตรงก็ยังต้องมี payload ตัวอย่างสำหรับ @ApiResponse วางไฟล์ entity แล้วเปลี่ยนค่าตัวอย่างในผลลัพธ์เป็นค่าที่สมจริง
เมื่อ query ด้วย relations: ["author"] frontend อยากรู้ว่า response ซ้อนลึกแค่ไหน ผลลัพธ์ทำให้เห็นชัดว่าฟิลด์ความสัมพันธ์ไหนเป็นออบเจ็กต์และไหนเป็นอาร์เรย์
ใช้ผลลัพธ์เป็นโครงของ request body สำหรับการเรียก POST ด้วย supertest ลบฟิลด์ที่สร้างอัตโนมัติอย่าง id และ timestamp แล้วเติมส่วนที่เหลือ
@Column อย่าง nullable, default หรือ length ค่ามาจากไทป์ของพร็อพเพอร์ตีหรือ initializer ที่เป็น literal (status = "draft") ถ้าคอลัมน์เป็น null ได้ ให้เปลี่ยนค่านั้นเป็น null เอง@Entity หลายตัวที่ไม่ได้อ้างถึงกันจะถูกแปลงทั้งหมดโดยใช้ชื่อคลาสเป็นคีย์ ({ "Book": {...}, "Author": {...} }) ส่วน entity ที่อ้างถึงกันยังให้รากเดียวแบบซ้อนnull@Expose, serialization group และ @Transform ที่ใช้กับ ClassSerializerInterceptor ไม่ถูกนำมาใช้@PrimaryGeneratedColumn("uuid") ของฉันเป็นสตริงว่าง?ไทป์ของพร็อพเพอร์ตีเท่านั้นที่กำหนดค่า id: string ให้ "" และอาร์กิวเมนต์ "uuid" ใน decorator ไม่ถูกอ่าน สำหรับเอกสาร ให้เปลี่ยนเป็นค่าที่มีรูปแบบ UUID ภายหลัง
ตรงกับผลของ JSON.stringify บน entity ที่โหลดครบทุกอย่าง ความสัมพันธ์ที่ไม่ได้โหลดด้วย relations จะไม่มีใน response จริง ให้ถือว่าฟิลด์ความสัมพันธ์ในผลลัพธ์คือกรณีที่โหลดแล้ว
ไดรเวอร์ของ PostgreSQL และ MySQL คืนค่า decimal เป็นสตริงเพื่อไม่ให้เสียความแม่นยำ ประกาศพร็อพเพอร์ตีเป็น price: string ใน entity แล้วผลลัพธ์จะเป็นสตริงเหมือนข้อมูลจริง