Tukar entiti TypeORM kepada JSON!

Masukkan entiti TypeORM untuk menjana contoh JSON! Menyokong TypeORM @Entity, @Column. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
TypeORM
Hasil
 

Tukar entiti TypeORM kepada JSON!

Tampal kelas entity TypeORM dan dapatkan bentuk JSON yang dihasilkan oleh entity tersebut apabila anda memulangkannya daripada API, diisi dengan nilai placeholder. Ia ditujukan untuk projek NestJS atau Express yang menghantar entity terus dalam respons dan memerlukan contoh Swagger atau sampel request/response untuk dipersetujui bersama frontend.

Nilai diambil daripada jenis TypeScript pada setiap property, bukan daripada pilihan @Column. Oleh itu, lajur yang diisytiharkan @Column({ type: "decimal" }) dengan price: number keluar sebagai nombor 0.

Cara menggunakan

  1. Tampal fail entity ke dalam kotak TypeORM. Sertakan entity berkaitan dan enum supaya objek bersarang dapat diisi.
  2. Hasil dalam kotak Hasil berubah sebaik sahaja anda menaip. Entity yang tidak dirujuk oleh entity lain menjadi objek JSON peringkat atas; jika ada beberapa entity yang tidak berkaitan, setiap satu muncul di bawah nama kelasnya.
  3. Ambil JSON dengan butang salin di bahagian atas kanan hasil, atau tekan Ctrl/⌘+Enter.

Contoh

Input (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;
}
Output (JSON)
{
  "id": "",
  "genre": "novel",
  "price": 0,
  "author": {
    "id": 0,
    "name": ""
  }
}

Book merujuk Author, jadi Book ialah akar dan author bersarang di dalamnya. internalCode digugurkan kerana @Exclude(), dan price yang berjenis number | null mengikut jenis bukan null yang pertama lalu menjadi 0. Primary key uuid berjenis string, jadi ia rentetan kosong.

Ciri yang disokong

  • Relasi @ManyToOne dan @OneToOne menjadi objek bersarang; Post[] daripada @OneToMany atau @ManyToMany menjadi array satu elemen.
  • Relasi lazy (Promise<Post[]>) dan wrapper ESM Relation<User> dibuka kepada jenis dalamannya.
  • Enum TypeScript menggunakan nilai ahli pertama: rentetan bagi enum rentetan, nombor bagi enum numerik.
  • Medan yang ditanda dengan @Exclude() class-transformer, medan static, method dan getter ditinggalkan.
  • Property Date (daripada @CreateDateColumn dan seumpamanya) menjadi rentetan ISO seperti 1970-01-01T00:00:00.000Z.
  • Jenis yang lazim pada lajur jsonb, seperti Record<string, number>, dipaparkan sebagai {"key": 0}.
  • Apabila entity saling merujuk, lawatan kedua dipotong dengan null atau array kosong supaya sarangan kekal terhingga.

Kes penggunaan

Contoh Swagger dalam controller NestJS

Controller yang memulangkan entity secara terus masih memerlukan contoh payload untuk @ApiResponse. Tampal fail entity dan gantikan nilai placeholder dalam hasil dengan nilai yang realistik.

Pratonton relasi yang dimuatkan

Apabila anda membuat query dengan relations: ["author"], frontend ingin tahu sedalam mana respons bersarang. Output menunjukkan dengan jelas medan relasi mana yang objek dan mana yang array.

Fixture untuk ujian e2e

Gunakan output sebagai rangka body request untuk panggilan POST supertest. Padam medan yang dijana seperti id dan timestamp, kemudian isi yang selebihnya.

Nota dan had

  • Pilihan @Column seperti nullable, default atau length tidak dibaca; nilainya diambil daripada jenis property atau initializer literal (status = "draft"). Jika lajur boleh null, tukar sendiri nilai itu kepada null.
  • Beberapa kelas @Entity yang tidak saling merujuk semuanya ditukar, dikunci mengikut nama kelas ({ "Book": {...}, "Author": {...} }). Entity yang saling merujuk tetap menghasilkan satu akar bersarang.
  • Kelas yang diimport dan bukan ditampal tidak diketahui oleh alat ini dan dipaparkan sebagai null.
  • @Expose, kumpulan serialisasi dan @Transform yang digunakan bersama ClassSerializerInterceptor tidak diterapkan.

Soalan lazim

Kenapa @PrimaryGeneratedColumn("uuid") saya ialah rentetan kosong?

Hanya jenis property yang menentukan nilai. id: string memberikan ""; argumen "uuid" dalam decorator tidak dibaca. Untuk dokumentasi, gantikan dengan nilai berbentuk UUID selepas itu.

Adakah ini benar-benar yang dipulangkan oleh API saya apabila menghantar entity?

Ia sepadan dengan JSON.stringify bagi entity yang dimuatkan sepenuhnya. Relasi yang tidak anda muatkan dengan relations tidak akan ada dalam respons sebenar, jadi anggap medan relasi dalam output sebagai kes yang telah dimuatkan.

Lajur decimal menunjukkan nombor, tetapi API saya memulangkan rentetan. Kenapa?

Driver PostgreSQL dan MySQL memulangkan nilai decimal sebagai rentetan untuk mengelakkan kehilangan ketepatan. Isytiharkan property sebagai price: string dalam entity dan output, seperti data sebenar anda, akan menjadi rentetan.