TypeORM 엔티티를 JSON으로 변환하세요!

TypeORM 엔티티(@Entity, @Column)를 입력하면 예시 JSON을 만듭니다! API 테스트용 요청 본문에.
TypeORM
결과
 

TypeORM 엔티티를 JSON으로 변환하세요!

TypeORM 엔티티 클래스를 붙여넣으면 그 엔티티를 API로 내보낼 때의 JSON 모양을 예시 값으로 채워 보여 줍니다. NestJS나 Express에서 엔티티를 그대로 응답에 쓰는 경우, Swagger 예시나 프런트엔드와 맞출 요청·응답 샘플을 만들 때 씁니다.

값은 @Column 옵션이 아니라 프로퍼티에 적힌 TypeScript 타입에서 정해집니다. 그래서 @Column({ type: "decimal" })이라도 price: number로 선언했다면 숫자 0이 나옵니다.

사용 방법

  1. TypeORM 칸에 엔티티 파일 내용을 붙여넣습니다. 관계로 연결된 엔티티와 enum도 같이 넣어야 중첩 객체가 채워집니다.
  2. 입력하는 동안 결과 칸이 바로 갱신됩니다. 다른 엔티티에서 참조되지 않는 엔티티가 최상위 JSON이 되고, 그런 엔티티가 여럿이면 클래스 이름별로 나뉘어 나옵니다.
  3. 결과 칸 오른쪽 위 복사 버튼(또는 Ctrl/⌘+Enter)으로 JSON을 가져갑니다.

예시

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

Book이 Author를 참조하므로 Book이 최상위가 되고 author는 중첩 객체로 들어갑니다. @Exclude()가 붙은 internalCode는 빠지고, number | null인 price는 null이 아닌 첫 타입을 따라 0이 됩니다. uuid 기본 키는 타입이 string이라 빈 문자열입니다.

지원 기능

  • @ManyToOne·@OneToOne 관계는 중첩 객체, @OneToMany·@ManyToMany의 Post[]는 원소 하나짜리 배열로 채웁니다.
  • lazy 관계 Promise<Post[]>와 ESM용 래퍼 Relation<User>는 안쪽 타입으로 풀어 줍니다.
  • TypeScript enum은 첫 멤버의 값(문자열 enum이면 그 문자열, 숫자 enum이면 숫자)을 씁니다.
  • class-transformer의 @Exclude()가 붙은 필드, static 필드, 메서드와 getter는 넣지 않습니다.
  • Date 타입(@CreateDateColumn 등)은 1970-01-01T00:00:00.000Z 형식의 ISO 문자열로 채웁니다.
  • Record<string, number>처럼 jsonb 컬럼에 자주 쓰는 타입은 {"key": 0} 모양으로 보여 줍니다.
  • 엔티티끼리 서로 참조하면 두 번째 방문부터 null 또는 빈 배열로 끊어서 무한 중첩을 막습니다.

사용 사례

NestJS 컨트롤러의 Swagger 예시

엔티티를 응답 타입으로 바로 반환하는 컨트롤러라면 @ApiResponse의 example에 넣을 JSON이 필요합니다. 엔티티 파일을 붙여넣어 나온 결과에서 값만 그럴듯하게 바꾸면 됩니다.

관계 로딩 결과 미리 보기

relations: ["author"]로 조회했을 때 응답이 어떤 깊이로 중첩되는지 프런트엔드 개발자와 공유할 때 유용합니다. 관계 필드가 객체인지 배열인지 한눈에 보입니다.

e2e 테스트 픽스처

supertest로 POST 요청을 보내는 테스트를 쓸 때 요청 본문의 뼈대로 씁니다. 자동 생성되는 id나 날짜 필드는 지우고 나머지만 채우면 됩니다.

주의사항

  • @Column({ nullable: true }), default, length 같은 데코레이터 옵션은 읽지 않고, 값은 프로퍼티 타입이나 리터럴 초기값(status = "draft")에서 정합니다. 값이 null일 수 있다면 예시에서 직접 null로 바꿔 주세요.
  • 서로 참조하지 않는 @Entity 클래스가 여러 개면 모두 변환해 { "Book": {...}, "Author": {...} }처럼 클래스 이름별로 보여 줍니다. 서로 참조하는 엔티티는 지금처럼 하나의 최상위 객체 안에 중첩됩니다.
  • 입력에 없는 클래스나 import한 타입은 null로 표시됩니다.
  • ClassSerializerInterceptor의 @Expose, 그룹, @Transform은 반영하지 않습니다.

자주 묻는 질문

@PrimaryGeneratedColumn("uuid")인데 왜 빈 문자열이 나오나요?

값은 프로퍼티 타입만 보고 정합니다. id: string이므로 ""가 되고, 데코레이터의 "uuid" 인자는 읽지 않습니다. 문서용이라면 결과에서 UUID 형식 값으로 바꿔 넣으세요.

TypeORM 엔티티를 JSON으로 응답하면 실제로도 이 모양인가요?

JSON.stringify 기준으로는 같습니다. 다만 조회할 때 relations로 불러오지 않은 관계는 실제 응답에 아예 없으니, 결과의 관계 필드는 로딩한 경우의 모양이라고 보면 됩니다.

decimal 컬럼이 숫자로 나오는데 실제로는 문자열이 오던데요?

PostgreSQL·MySQL 드라이버는 decimal을 정밀도 손실을 피하려고 문자열로 돌려줍니다. 엔티티에서 price: string으로 선언하면 이 도구도 문자열로 보여 주고, 실제 타입과도 맞습니다.