Cole classes de entity do TypeORM e receba o formato JSON que essas entities geram quando você as retorna de uma API, preenchido com valores placeholder. É pensado para projetos NestJS ou Express que mandam as entities direto nas respostas e precisam de exemplos do Swagger ou de amostras de request/response para combinar com o frontend.
Os valores vêm do tipo TypeScript de cada propriedade, não das opções do @Column. Uma coluna declarada como @Column({ type: "decimal" }) com price: number sai, portanto, como o número 0.
TypeORM. Inclua as entities relacionadas e os enums para que os objetos aninhados possam ser preenchidos.Resultado se atualiza conforme você digita. Uma entity que nenhuma outra referencia vira o objeto JSON de nível mais alto; se houver várias entities sem relação entre si, cada uma aparece sob o nome da sua classe.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 referencia Author, então Book é a raiz e author fica aninhado dentro dele. internalCode é descartado por causa do @Exclude(), e price, tipado como number | null, segue o primeiro tipo não nulo e vira 0. A primary key uuid é tipada como string, então é uma string vazia.
@ManyToOne e @OneToOne viram objetos aninhados; Post[] de @OneToMany ou @ManyToMany vira um array de um elemento.Promise<Post[]>) e o wrapper ESM Relation<User> são desembrulhados para o tipo interno.@Exclude() do class-transformer, campos static, métodos e getters ficam de fora.Date (de @CreateDateColumn e afins) viram strings ISO como 1970-01-01T00:00:00.000Z.Record<string, number>, aparecem como {"key": 0}.null ou um array vazio para o aninhamento ser finito.Controllers que retornam entities direto ainda precisam de um payload de exemplo para o @ApiResponse. Cole o arquivo da entity e troque os valores placeholder do resultado por valores realistas.
Quando você consulta com relations: ["author"], o frontend quer saber o quão profundo a resposta aninha. A saída deixa óbvio quais campos de relação são objetos e quais são arrays.
Use a saída como esqueleto de um request body para chamadas POST com supertest. Apague campos gerados como id e os timestamps e depois preencha o resto.
@Column como nullable, default ou length não são lidas; o valor vem do tipo da propriedade ou de um inicializador literal (status = "draft"). Se uma coluna pode ser null, troque esse valor por null você mesmo.@Entity que não se referenciam são todas convertidas, organizadas por nome de classe ({ "Book": {...}, "Author": {...} }). Entities que se referenciam continuam gerando uma única raiz aninhada.null.@Expose, grupos de serialização e @Transform usados com o ClassSerializerInterceptor não são aplicados.@PrimaryGeneratedColumn("uuid") é uma string vazia?Só o tipo da propriedade decide o valor. id: string dá ""; o argumento "uuid" do decorator não é lido. Para documentação, troque depois por um valor com formato de UUID.
Corresponde ao JSON.stringify de uma entity totalmente carregada. Relações que você não carregou com relations simplesmente não aparecem na resposta real, então trate os campos de relação da saída como o caso carregado.
Os drivers do PostgreSQL e do MySQL devolvem valores decimal como string para evitar perda de precisão. Declare a propriedade como price: string na entity e a saída, como os seus dados reais, será uma string.