Ubah entitas TypeORM menjadi JSON!

Masukkan entitas TypeORM untuk membuat contoh JSON! Mendukung TypeORM @Entity, @Column. Berguna untuk dokumentasi API dan body request uji (mock request body).
TypeORM
Hasil
 

Ubah entitas TypeORM menjadi JSON!

Tempel class entity TypeORM dan dapatkan bentuk JSON yang dihasilkan entity tersebut saat Anda mengembalikannya dari API, diisi dengan nilai placeholder. Ditujukan untuk proyek NestJS atau Express yang langsung mengirim entity di respons dan butuh contoh Swagger atau contoh request/response untuk disepakati dengan frontend.

Nilai diambil dari tipe TypeScript di setiap properti, bukan dari opsi @Column. Kolom yang dideklarasikan @Column({ type: "decimal" }) dengan price: number karena itu keluar sebagai number 0.

Cara menggunakan

  1. Tempel file entity ke kolom TypeORM. Sertakan entity terkait dan enum agar objek bersarang bisa terisi.
  2. Isi kolom Hasil langsung berubah saat Anda mengetik. Entity yang tidak direferensikan entity lain menjadi objek JSON tingkat atas; jika ada beberapa entity yang tidak saling terkait, masing-masing muncul di bawah nama class-nya.
  3. Ambil JSON dengan tombol salin di kanan atas 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 mereferensikan Author, jadi Book menjadi root dan author bersarang di dalamnya. internalCode dibuang karena @Exclude(), dan price, yang bertipe number | null, mengikuti tipe non-null pertama dan menjadi 0. Primary key uuid bertipe string, jadi berupa string kosong.

Fitur yang didukung

  • Relasi @ManyToOne dan @OneToOne menjadi objek bersarang; Post[] dari @OneToMany atau @ManyToMany menjadi array satu elemen.
  • Relasi lazy (Promise<Post[]>) dan wrapper ESM Relation<User> dibuka menjadi tipe di dalamnya.
  • Enum TypeScript memakai nilai member pertama: string untuk string enum, angka untuk enum numerik.
  • Field yang ditandai @Exclude() dari class-transformer, field static, method, dan getter tidak disertakan.
  • Properti Date (dari @CreateDateColumn dan sejenisnya) menjadi string ISO seperti 1970-01-01T00:00:00.000Z.
  • Tipe yang umum di kolom jsonb, seperti Record<string, number>, ditampilkan sebagai {"key": 0}.
  • Ketika entity saling mereferensikan, kunjungan kedua dipotong dengan null atau array kosong agar nesting tetap terbatas.

Kasus penggunaan

Contoh Swagger di controller NestJS

Controller yang langsung mengembalikan entity tetap butuh contoh payload untuk @ApiResponse. Tempel file entity lalu ganti nilai placeholder di hasil dengan nilai yang realistis.

Pratinjau relasi yang dimuat

Saat Anda melakukan query dengan relations: ["author"], frontend ingin tahu seberapa dalam respons bersarang. Output memperjelas field relasi mana yang berupa objek dan mana yang berupa array.

Fixture untuk test e2e

Gunakan output sebagai kerangka body request untuk pemanggilan POST di supertest. Hapus field yang dibuat otomatis seperti id dan timestamp, lalu isi sisanya.

Catatan dan batasan

  • Opsi @Column seperti nullable, default atau length tidak dibaca; nilainya diambil dari tipe properti atau initializer literal (status = "draft"). Jika sebuah kolom bisa null, ubah sendiri nilainya menjadi null.
  • Beberapa class @Entity yang tidak saling mereferensikan semuanya dikonversi, dengan key berupa nama class ({ "Book": {...}, "Author": {...} }). Entity yang saling mereferensikan tetap menghasilkan satu root bersarang.
  • Class yang di-import alih-alih ditempel tidak dikenal oleh alat ini dan muncul sebagai null.
  • @Expose, serialization group, dan @Transform yang dipakai bersama ClassSerializerInterceptor tidak diterapkan.

FAQ

Mengapa @PrimaryGeneratedColumn("uuid") saya berupa string kosong?

Hanya tipe properti yang menentukan nilainya. id: string menghasilkan ""; argumen "uuid" di decorator tidak dibaca. Untuk dokumentasi, ganti dengan nilai berbentuk UUID setelahnya.

Apakah ini benar-benar yang dikembalikan API saya saat mengirim entity?

Hasilnya sama dengan JSON.stringify dari entity yang dimuat penuh. Relasi yang tidak Anda muat dengan relations tidak akan ada di respons sebenarnya, jadi anggap field relasi di output sebagai kasus ketika relasinya dimuat.

Kolom decimal menampilkan number, tetapi API saya mengembalikan string. Kenapa?

Driver PostgreSQL dan MySQL mengembalikan nilai decimal sebagai string untuk menghindari hilangnya presisi. Deklarasikan properti sebagai price: string di entity dan output-nya, seperti data Anda yang sebenarnya, akan berupa string.