Collez des classes d'entité TypeORM et obtenez la forme JSON que produisent ces entités quand vous les renvoyez depuis une API, remplie de valeurs génériques. C'est pensé pour les projets NestJS ou Express qui renvoient directement les entités dans les réponses et ont besoin d'exemples Swagger ou d'échantillons de requête/réponse à valider avec le frontend.
Les valeurs viennent du type TypeScript de chaque propriété, pas des options de @Column. Une colonne déclarée @Column({ type: "decimal" }) avec price: number sort donc comme le nombre 0.
TypeORM. Incluez les entités liées et les enums pour que les objets imbriqués puissent être remplis.Résultat est actualisé au fil de la frappe. Une entité qu'aucune autre ne référence devient l'objet JSON de premier niveau ; s'il y a plusieurs entités sans lien, chacune apparaît sous son nom de 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 référence Author : Book est donc la racine et author est imbriqué dedans. internalCode est supprimé à cause de @Exclude(), et price, typé number | null, suit le premier type non nul et devient 0. La clé primaire uuid est typée string : c'est donc une chaîne vide.
@ManyToOne et @OneToOne deviennent des objets imbriqués ; un Post[] issu de @OneToMany ou @ManyToMany devient un tableau d'un élément.Promise<Post[]>) et le wrapper ESM Relation<User> sont déballés vers le type interne.@Exclude() de class-transformer, les champs static, les méthodes et les getters sont omis.Date (issues de @CreateDateColumn et similaires) deviennent des chaînes ISO comme 1970-01-01T00:00:00.000Z.Record<string, number>, sont affichés sous la forme {"key": 0}.null ou un tableau vide pour que l'imbrication reste finie.Les contrôleurs qui renvoient directement des entités ont quand même besoin d'un payload d'exemple pour @ApiResponse. Collez le fichier d'entités et remplacez les valeurs génériques du résultat par des valeurs réalistes.
Quand vous faites une requête avec relations: ["author"], le frontend veut savoir jusqu'où la réponse s'imbrique. La sortie montre clairement quels champs de relation sont des objets et lesquels sont des tableaux.
Servez-vous de la sortie comme squelette de corps de requête pour des appels POST avec supertest. Supprimez les champs générés comme id et les timestamps, puis complétez le reste.
@Column comme nullable, default ou length ne sont pas lues ; la valeur vient du type de la propriété ou d'un initialiseur littéral (status = "draft"). Si une colonne peut être nulle, remplacez vous-même cette valeur par null.@Entity qui ne se référencent pas sont toutes converties, indexées par nom de classe ({ "Book": {...}, "Author": {...} }). Des entités qui se référencent produisent toujours une seule racine imbriquée.null.@Expose, les groupes de sérialisation et @Transform utilisés avec ClassSerializerInterceptor ne sont pas appliqués.@PrimaryGeneratedColumn("uuid") est-il une chaîne vide ?Seul le type de la propriété détermine la valeur. id: string donne "" ; l'argument "uuid" du décorateur n'est pas lu. Pour une documentation, remplacez-le ensuite par une valeur ayant la forme d'un UUID.
Cela correspond au JSON.stringify d'une entité entièrement chargée. Les relations que vous n'avez pas chargées avec relations sont tout simplement absentes de la vraie réponse : considérez les champs de relation de la sortie comme le cas chargé.
Les drivers PostgreSQL et MySQL renvoient les valeurs decimal sous forme de chaînes pour éviter la perte de précision. Déclarez la propriété price: string dans l'entité et la sortie sera une chaîne, comme vos vraies données.