TypeORM-Entitäten in JSON umwandeln!

Gib TypeORM-Entitäten ein, um Beispiel-JSON zu erzeugen! Unterstützt TypeORM @Entity, @Column. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
TypeORM
Ergebnis
 

TypeORM-Entitäten in JSON umwandeln!

Füge TypeORM-Entity-Klassen ein und erhalte die JSON-Form, die diese Entities erzeugen, wenn du sie aus einer API zurückgibst, befüllt mit Platzhalterwerten. Gedacht ist das für NestJS- oder Express-Projekte, die Entities direkt in Antworten zurückschicken und Swagger-Beispiele oder Request-/Response-Beispiele brauchen, um sich mit dem Frontend abzustimmen.

Die Werte stammen aus dem TypeScript-Typ jeder Property, nicht aus den @Column-Optionen. Eine als @Column({ type: "decimal" }) deklarierte Spalte mit price: number kommt daher als Zahl 0 heraus.

So funktioniert es

  1. Füge die Entity-Datei in das Feld TypeORM ein. Nimm verwandte Entities und Enums mit auf, damit verschachtelte Objekte befüllt werden können.
  2. Das Feld Ergebnis aktualisiert sich beim Tippen. Eine Entity, auf die keine andere Entity verweist, wird zum JSON-Objekt auf oberster Ebene; gibt es mehrere voneinander unabhängige Entities, erscheint jede unter ihrem Klassennamen.
  3. Hol dir das JSON mit dem Kopier-Button oben rechts im Ergebnis oder drück Strg/⌘+Enter.

Beispiel

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

Book verweist auf Author, daher ist Book die Wurzel und author darin verschachtelt. internalCode fällt wegen @Exclude() weg, und price mit dem Typ number | null folgt dem ersten Nicht-null-Typ und wird zu 0. Der UUID-Primärschlüssel ist als string typisiert und daher ein leerer String.

Unterstützte Funktionen

  • @ManyToOne- und @OneToOne-Relationen werden zu verschachtelten Objekten; Post[] aus @OneToMany oder @ManyToMany wird zu einem Array mit einem Element.
  • Lazy-Relationen (Promise<Post[]>) und der ESM-Wrapper Relation<User> werden zum inneren Typ ausgepackt.
  • TypeScript-Enums verwenden den Wert des ersten Members: den String bei String-Enums, die Zahl bei numerischen.
  • Mit @Exclude() von class-transformer markierte Felder, static-Felder, Methoden und Getter werden weggelassen.
  • Date-Properties (aus @CreateDateColumn und ähnlichen) werden zu ISO-Strings wie 1970-01-01T00:00:00.000Z.
  • Bei jsonb-Spalten übliche Typen wie Record<string, number> werden als {"key": 0} dargestellt.
  • Verweisen Entities aufeinander, wird der zweite Besuch mit null oder einem leeren Array abgeschnitten, damit die Verschachtelung endlich bleibt.

Anwendungsfälle

Swagger-Beispiele in NestJS-Controllern

Auch Controller, die Entities direkt zurückgeben, brauchen ein Beispiel-Payload für @ApiResponse. Füge die Entity-Datei ein und ersetze die Platzhalterwerte im Ergebnis durch realistische.

Geladene Relationen vorab ansehen

Fragst du mit relations: ["author"] ab, will das Frontend wissen, wie tief die Antwort verschachtelt ist. Die Ausgabe macht deutlich, welche Relationsfelder Objekte und welche Arrays sind.

Fixtures für E2E-Tests

Verwende die Ausgabe als Gerüst eines Request-Bodys für POST-Aufrufe mit supertest. Lösche erzeugte Felder wie id und die Timestamps und fülle dann den Rest aus.

Hinweise und Einschränkungen

  • @Column-Optionen wie nullable, default oder length werden nicht gelesen; der Wert ergibt sich aus dem Property-Typ oder einem literalen Initialisierer (status = "draft"). Kann eine Spalte null sein, ändere diesen Wert selbst auf null.
  • Mehrere @Entity-Klassen, die nicht aufeinander verweisen, werden alle umgewandelt und nach Klassennamen geschlüsselt ({ "Book": {...}, "Author": {...} }). Entities, die aufeinander verweisen, ergeben weiterhin eine verschachtelte Wurzel.
  • Importierte statt eingefügte Klassen kennt das Tool nicht, sie erscheinen als null.
  • @Expose, Serialisierungsgruppen und @Transform, wie sie mit ClassSerializerInterceptor verwendet werden, werden nicht angewendet.

Häufige Fragen

Warum ist mein @PrimaryGeneratedColumn("uuid") ein leerer String?

Nur der Property-Typ bestimmt den Wert. id: string ergibt ""; das Argument "uuid" im Decorator wird nicht gelesen. Für die Dokumentation setzt du hinterher einen Wert in UUID-Form ein.

Gibt meine API wirklich genau das zurück, wenn sie eine Entity sendet?

Es entspricht JSON.stringify einer vollständig geladenen Entity. Relationen, die du nicht mit relations geladen hast, fehlen in der echten Antwort einfach; betrachte Relationsfelder in der Ausgabe also als den geladenen Fall.

Die Decimal-Spalte zeigt eine Zahl, meine API gibt aber einen String zurück. Warum?

Die Treiber für PostgreSQL und MySQL geben Decimal-Werte als Strings zurück, um Genauigkeitsverluste zu vermeiden. Deklariere die Property in der Entity als price: string, dann ist auch die Ausgabe, wie deine echten Daten, ein String.