将 Sequelize (TS) 模型 转换为 JSON!

输入 Sequelize (TS) 模型,即可生成示例 JSON!支持 Sequelize, sequelize-typescript。适用于 API 文档和测试请求体(sample JSON)。
Sequelize (TS)
结果
 

将 Sequelize (TS) 模型 转换为 JSON!

把用 sequelize-typescript 编写的 @Table 模型类交给它,就会生成与实例 toJSON() 输出形状相同的示例 JSON。其中包括即使类中没有声明,Sequelize 也会添加的 id、createdAt、updatedAt 和 deletedAt 属性。

与 JS 页面不同,这里的值来自每个属性的 TypeScript 类型,而不是 DataType 参数。声明为 amount: string 的 @Column(DataType.DECIMAL) 会生成字符串。

使用方法

  1. 把包含 @Table 类的文件粘贴到 Sequelize (TS) 框中。加上关联的模型(通过 @HasMany 等)就能得到嵌套的值。
  2. 在 结果 框中查看带有自动添加属性的 JSON。
  3. 切换 timestamps、paranoid 等 @Table 选项,立即看到日期字段如何变化。

示例

输入 (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 继承的内容全部忽略。
  • 类型为对象(如 { theme: string })的 DataType.JSON 列会按该结构填充。

使用场景

为 Express 处理函数写文档

对于执行 res.json(await Invoice.findByPk(id)) 的接口,输出给出的响应示例中 key 与实际一致,包括自动添加的属性。

开启软删除前后的对比

开启 paranoid 后,每个响应都会多出 deletedAt。对比该选项开和关时的输出,就能准确告诉 API 使用方会有哪些变化。

注意事项与限制

  • 嵌套在根模型中的关联模型,会按各自 @Table 选项得到自己的 id 和时间戳;但 Sequelize 隐式添加的外键(例如没有 @ForeignKey 列的 @HasMany 目标上的 invoiceId)不会被凭空生成。
  • allowNull 以及通过 @Column({ field: ... }) 进行的列重命名会被忽略,因为 JSON key 就是属性名。@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,不会被展开。

本页能处理用 JavaScript 编写的 sequelize.define 模型吗?

不能。本页读取的是类和 TypeScript 类型。define 和 Model.init 模型请使用 Sequelize (JS) 转 JSON 页面,它读取的是 DataTypes。