Sequelize(TS) 모델을 JSON으로 변환하세요!

Sequelize(TypeScript) 모델을 입력하면 예시 JSON을 만듭니다! API 테스트용 요청 본문에.
Sequelize (TS)
결과
 

Sequelize(TS) 모델을 JSON으로 변환하세요!

sequelize-typescript로 작성한 @Table 모델 클래스를 넣으면, 그 모델 인스턴스의 toJSON() 결과와 같은 모양의 예시 JSON을 만듭니다. 클래스에 적지 않았어도 Sequelize가 자동으로 붙이는 id, createdAt, updatedAt, deletedAt까지 포함됩니다.

JS 버전 페이지와 달리 이 페이지는 DataType 인자가 아니라 프로퍼티의 TypeScript 타입으로 값을 정합니다. @Column(DataType.DECIMAL)이라도 amount: string이면 문자열이 나옵니다.

사용 방법

  1. Sequelize (TS) 칸에 @Table 클래스가 들어 있는 파일을 붙여넣습니다. @HasMany 등으로 연결된 모델도 함께 넣으면 중첩 값이 채워집니다.
  2. 결과 칸에서 자동 추가 필드가 붙은 JSON을 확인합니다.
  3. @Table 옵션(timestamps, paranoid)을 바꿔 보면 날짜 필드가 어떻게 달라지는지 바로 비교할 수 있습니다.

예시

입력 (sequelize-typescript)
@Table({ tableName: "invoices", paranoid: true })
export class Invoice extends Model {
  @Column(DataType.STRING(20))
  number: string;

  @Column(DataType.DECIMAL(10, 2))
  amount: string;

  @Column(DataType.ENUM("draft", "sent", "paid"))
  status: "draft" | "sent" | "paid";

  @ForeignKey(() => Customer)
  @Column
  customerId: number;
}
출력 (JSON)
{
  "id": 0,
  "number": "",
  "amount": "",
  "status": "draft",
  "customerId": 0,
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "deletedAt": null
}

클래스에 기본 키가 없어서 id가 맨 앞에 추가되고, paranoid: true 때문에 deletedAt: null이 붙었습니다. status는 유니온 타입의 첫 리터럴 "draft", amount는 string으로 선언했으므로 빈 문자열입니다.

지원 기능

  • @PrimaryKey나 @Column({ primaryKey: true }), id 프로퍼티가 없으면 id: 0을 맨 앞에 넣습니다. 최상위뿐 아니라 연결된 모델에도 같은 규칙을 적용합니다.
  • @Table에 timestamps: false가 없으면 createdAt·updatedAt을 덧붙이고, createdAt: "created_on" 같은 이름 바꾸기, updatedAt: false, paranoid: true(deletedAt: null)도 모델마다 그 클래스의 옵션대로 반영합니다.
  • @HasMany의 Post[]는 배열, @BelongsTo·@HasOne은 중첩 객체로 채웁니다.
  • "draft" | "sent" 같은 리터럴 유니온은 첫 값, extends Model로 상속받는 메서드는 무시합니다.
  • DataType.JSON 컬럼을 { theme: string }처럼 객체 타입으로 선언했다면 그 모양대로 채웁니다.

사용 사례

Express 라우터 응답 문서화

res.json(await Invoice.findByPk(id))처럼 모델을 그대로 내보내는 엔드포인트의 응답 예시를 만들 때 씁니다. 자동 필드까지 들어 있어 실제 응답과 키 목록이 맞습니다.

soft delete 도입 전후 비교

paranoid 옵션을 켜면 응답에 deletedAt이 새로 생깁니다. 옵션을 바꿔 가며 결과를 비교해 클라이언트가 받게 될 변화를 미리 알릴 수 있습니다.

주의사항

  • 중첩된 연결 모델에도 그 클래스 @Table 옵션에 맞춰 id와 날짜 필드가 붙습니다. 다만 @ForeignKey 컬럼으로 선언하지 않은 외래 키(@HasMany 대상의 invoiceId 등)를 Sequelize처럼 만들어 넣지는 않습니다.
  • allowNull과 @Column({ field: ... })로 바꾼 컬럼 이름은 반영하지 않습니다. JSON 키는 프로퍼티 이름 그대로입니다. @Default("x")나 @Column({...}) 안의 리터럴 defaultValue는 예시 값으로 씁니다.
  • underscored: true라도 toJSON()의 키는 속성 이름이므로 결과의 createdAt 표기가 맞습니다.
  • 값은 TypeScript 타입에서 나오므로, 타입 표기 없이 데코레이터로만 타입을 준 프로퍼티(@Column(DataType.INTEGER) count;)는 null이 됩니다.

자주 묻는 질문

DECIMAL 컬럼은 number와 string 중 무엇으로 선언해야 하나요?

MySQL·PostgreSQL에서 Sequelize는 DECIMAL을 문자열로 돌려주는 것이 기본입니다. amount: string으로 선언해 두면 타입과 실제 값이 일치하고, 이 도구의 예시도 문자열로 나옵니다.

declare 필드나 CreationOptional을 써도 되나요?

네. declare id: CreationOptional<number>는 number로 읽고, NonAttribute<...>·ForeignKey<...>도 안쪽 타입으로 풉니다. InferAttributes 같은 그 밖의 유틸리티 타입은 펼치지 않습니다.

JS로 작성한 sequelize.define 모델도 여기서 되나요?

아닙니다. 이 페이지는 클래스와 TypeScript 타입을 읽습니다. define·Model.init 모델은 Sequelize (JS) → JSON 페이지에서 DataTypes 기준으로 변환하세요.