I-convert ang mga TypeORM entity sa JSON!

Maglagay ng mga TypeORM entity para gumawa ng halimbawang JSON! Sinusuportahan ang TypeORM @Entity, @Column. Magagamit sa API docs at test request body (mock request body).
TypeORM
Resulta
 

I-convert ang mga TypeORM entity sa JSON!

I-paste ang mga TypeORM entity class at makukuha mo ang hugis ng JSON na nalilikha ng mga entity na iyon kapag ibinalik mo sila mula sa isang API, na puno ng mga placeholder value. Para ito sa mga NestJS o Express project na direktang ibinabalik ang mga entity sa mga response at kailangan ng mga Swagger example o request/response sample na pagkakasunduan kasama ang frontend.

Galing sa TypeScript type ng bawat property ang mga value, hindi sa mga option ng @Column. Kaya lumalabas bilang numerong 0 ang column na naka-declare na @Column({ type: "decimal" }) na may price: number.

Paano gamitin

  1. I-paste ang entity file sa TypeORM box. Isama ang mga kaugnay na entity at enum para mapunan ang mga nested object.
  2. Sumasabay sa pagta-type mo ang pag-update ng Resulta box. Ang entity na hindi nire-reference ng ibang entity ang nagiging top-level na JSON object; kung may ilang hindi magkakaugnay na entity, lumalabas ang bawat isa sa ilalim ng class name nito.
  3. Kunin ang JSON gamit ang copy button sa kanang itaas ng resulta, o pindutin ang Ctrl/⌘+Enter.

Halimbawa

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": ""
  }
}

Nire-reference ng Book ang Author, kaya Book ang root at naka-nest sa loob nito ang author. Tinatanggal ang internalCode dahil sa @Exclude(), at ang price, na may type na number | null, ay sumusunod sa unang type na hindi null at nagiging 0. May type na string ang uuid na primary key, kaya empty string ito.

Mga sinusuportahang feature

  • Nagiging nested object ang mga relation na @ManyToOne at @OneToOne; nagiging array na may isang element ang Post[] mula sa @OneToMany o @ManyToMany.
  • Ina-unwrap sa inner type ang mga lazy relation (Promise<Post[]>) at ang ESM wrapper na Relation<User>.
  • Ginagamit ng mga TypeScript enum ang value ng unang member: ang string para sa mga string enum, ang numero para sa mga numeric.
  • Hindi kasama ang mga field na may markang @Exclude() ng class-transformer, mga static field, method at getter.
  • Nagiging ISO string gaya ng 1970-01-01T00:00:00.000Z ang mga Date property (mula sa @CreateDateColumn at mga katulad).
  • Ipinapakita bilang {"key": 0} ang mga type na karaniwan sa mga jsonb column, gaya ng Record<string, number>.
  • Kapag nagre-reference sa isa't isa ang mga entity, pinuputol gamit ang null o empty array ang pangalawang pagbisita para may hangganan ang nesting.

Mga gamit

Mga Swagger example sa mga NestJS controller

Kailangan pa rin ng example payload para sa @ApiResponse ang mga controller na direktang nagbabalik ng mga entity. I-paste ang entity file at palitan ng makatotohanang value ang mga placeholder sa resulta.

Pag-preview ng mga na-load na relation

Kapag nagku-query ka gamit ang relations: ["author"], gustong malaman ng frontend kung gaano kalalim ang nesting ng response. Malinaw sa output kung aling mga relation field ang object at alin ang array.

Mga fixture para sa e2e test

Gamitin ang output bilang skeleton ng request body para sa mga supertest POST call. Burahin ang mga generated na field gaya ng id at ang mga timestamp, saka punan ang iba.

Mga paalala at limitasyon

  • Hindi binabasa ang mga option ng @Column gaya ng nullable, default o length; galing sa property type o sa isang literal initializer (status = "draft") ang value. Kung puwedeng null ang isang column, ikaw na ang magpalit ng value na iyon sa null.
  • Kino-convert lahat ang ilang @Entity class na hindi nagre-reference sa isa't isa, naka-key ayon sa class name ({ "Book": {...}, "Author": {...} }). Iisang nested na root pa rin ang nalilikha ng mga entity na nagre-reference sa isa't isa.
  • Hindi kilala ng tool ang mga class na in-import sa halip na na-paste, at lumalabas sila bilang null.
  • Hindi ina-apply ang @Expose, mga serialization group at @Transform na ginagamit kasama ang ClassSerializerInterceptor.

Mga madalas itanong

Bakit empty string ang @PrimaryGeneratedColumn("uuid") ko?

Ang property type lang ang nagpapasya sa value. "" ang ibinibigay ng id: string; hindi binabasa ang argument na "uuid" sa decorator. Para sa dokumentasyon, palitan ito ng value na hugis-UUID pagkatapos.

Ito ba talaga ang ibinabalik ng API ko kapag nagpapadala ito ng entity?

Tugma ito sa JSON.stringify ng isang buong na-load na entity. Wala lang sa totoong response ang mga relation na hindi mo na-load gamit ang relations, kaya ituring na kasong naka-load ang mga relation field sa output.

Numero ang ipinapakita ng decimal column, pero string ang ibinabalik ng API ko. Bakit?

Ibinabalik ng mga PostgreSQL at MySQL driver ang mga decimal value bilang string para maiwasan ang pagkawala ng precision. I-declare ang property bilang price: string sa entity at magiging string ang output, gaya ng totoong data mo.