Chuyển entity TypeORM thành JSON!

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

Chuyển entity TypeORM thành JSON!

Dán các class entity TypeORM để nhận hình dạng JSON mà các entity đó tạo ra khi bạn trả chúng từ API, được điền bằng giá trị giữ chỗ. Công cụ dành cho dự án NestJS hay Express trả thẳng entity trong response và cần ví dụ Swagger hoặc mẫu request/response để thống nhất với frontend.

Giá trị lấy từ kiểu TypeScript trên mỗi property, không phải từ option của @Column. Vì vậy một cột khai báo @Column({ type: "decimal" }) với price: number sẽ ra số 0.

Cách sử dụng

  1. Dán file entity vào ô TypeORM. Đưa vào cả entity có quan hệ và enum để object lồng nhau được điền giá trị.
  2. Ô Kết quả cập nhật ngay khi bạn gõ. Entity không bị entity nào khác tham chiếu thành object JSON cấp cao nhất; nếu có nhiều entity không liên quan, mỗi entity xuất hiện dưới tên class của nó.
  3. Lấy JSON bằng nút sao chép ở góc trên bên phải của kết quả, hoặc nhấn Ctrl/⌘+Enter.

Ví dụ

Đầu vào (TypeORM)
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;
}
Đầu ra (JSON)
{
  "id": "",
  "genre": "novel",
  "price": 0,
  "author": {
    "id": 0,
    "name": ""
  }
}

Book tham chiếu Author, nên Book là gốc và author lồng bên trong. internalCode bị bỏ vì @Exclude(), còn price, kiểu number | null, theo kiểu không null đầu tiên và thành 0. Khóa chính uuid có kiểu string nên là chuỗi rỗng.

Tính năng hỗ trợ

  • Quan hệ @ManyToOne và @OneToOne thành object lồng nhau; Post[] từ @OneToMany hoặc @ManyToMany thành mảng một phần tử.
  • Quan hệ lazy (Promise<Post[]>) và wrapper ESM Relation<User> được mở thành kiểu bên trong.
  • Enum TypeScript dùng giá trị của member đầu tiên: chuỗi với string enum, số với numeric enum.
  • Field có @Exclude() của class-transformer, field static, method và getter bị bỏ ra.
  • Property Date (từ @CreateDateColumn và tương tự) thành chuỗi ISO như 1970-01-01T00:00:00.000Z.
  • Các kiểu hay gặp trên cột jsonb, như Record<string, number>, hiện thành {"key": 0}.
  • Khi các entity tham chiếu lẫn nhau, lần ghé thứ hai bị cắt bằng null hoặc mảng rỗng để độ lồng nhau có giới hạn.

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

Ví dụ Swagger trong controller NestJS

Controller trả thẳng entity vẫn cần payload ví dụ cho @ApiResponse. Dán file entity rồi thay các giá trị giữ chỗ trong kết quả bằng giá trị thực tế.

Xem trước quan hệ đã nạp

Khi bạn truy vấn với relations: ["author"], frontend muốn biết response lồng sâu đến đâu. Output cho thấy rõ field quan hệ nào là object và field nào là mảng.

Fixture cho test e2e

Dùng output làm khung body request cho lời gọi POST bằng supertest. Xóa các field được tạo như id và timestamp, rồi điền phần còn lại.

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

  • Option của @Column như nullable, default hay length không được đọc; giá trị lấy từ kiểu property hoặc initializer dạng literal (status = "draft"). Nếu cột có thể null, hãy tự đổi giá trị đó thành null.
  • Nhiều class @Entity không tham chiếu lẫn nhau đều được chuyển, đặt key theo tên class ({ "Book": {...}, "Author": {...} }). Entity có tham chiếu lẫn nhau vẫn cho ra một gốc lồng nhau duy nhất.
  • Class được import chứ không được dán vào thì công cụ không biết và hiện thành null.
  • @Expose, serialization group và @Transform dùng với ClassSerializerInterceptor không được áp dụng.

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

Vì sao @PrimaryGeneratedColumn("uuid") của tôi là chuỗi rỗng?

Chỉ kiểu property quyết định giá trị. id: string cho ""; tham số "uuid" trong decorator không được đọc. Với tài liệu, hãy thay bằng giá trị có dạng UUID sau đó.

Đây có thật là thứ API trả về khi gửi entity không?

Nó khớp với JSON.stringify của một entity đã nạp đầy đủ. Quan hệ không được nạp bằng relations sẽ đơn giản là không có trong response thật, nên hãy coi field quan hệ trong output là trường hợp đã nạp.

Cột decimal hiện số, nhưng API của tôi trả về chuỗi. Tại sao?

Driver PostgreSQL và MySQL trả giá trị decimal dưới dạng chuỗi để tránh mất độ chính xác. Khai báo property là price: string trong entity, khi đó output, giống dữ liệu thật của bạn, sẽ là chuỗi.