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

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

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

读取用纯 JavaScript 编写的 Sequelize 模型,即 sequelize.define("User", {...}) 或 Model.init({...}, {...}),并转换成示例 JSON。由于没有类型注解可依据,每个属性的值都根据它的 DataTypes 来决定。

适合没有使用 TypeScript、跑着 Express 和 Sequelize 的老 Node.js 服务器,在那里模型文件是 API 响应或种子数据结构的唯一描述。

使用方法

  1. 把模型文件粘贴到 Sequelize (JS) 框中。残留的 require 行和 module.exports 都没关系。
  2. 如果文件定义了多个模型,输出会以模型名为 key,例如 { "User": {...}, "Post": {...} }。
  3. 确认 timestamps、paranoid 或改名后的 createdAt 等模型选项(第二个参数)已经体现在结果中,然后复制。

示例

输入 (Sequelize · JavaScript)
class Reservation extends Model {}

Reservation.init(
  {
    code: { type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true },
    guests: DataTypes.SMALLINT,
    checkIn: DataTypes.DATEONLY,
    arrivalTime: DataTypes.TIME,
    options: DataTypes.JSONB,
    tags: DataTypes.ARRAY(DataTypes.STRING),
  },
  { sequelize, modelName: "Reservation", updatedAt: false }
);
输出 (JSON)
{
  "code": "00000000-0000-0000-0000-000000000000",
  "guests": 0,
  "checkIn": "1970-01-01",
  "arrivalTime": "00:00:00",
  "options": {},
  "tags": [
    ""
  ],
  "createdAt": "1970-01-01T00:00:00.000Z"
}

code 带有 primaryKey: true,所以不会添加 id;它的 defaultValue 是 DataTypes.UUIDV4,属于生成器而非字面量,因此显示占位 UUID。updatedAt: false 让 createdAt 成为唯一的时间戳,DATEONLY、TIME、JSONB 和 ARRAY(STRING) 分别变成日期字符串、时间字符串、空对象和单元素数组。

支持的功能

  • DataTypes.STRING、TEXT、CHAR → "";INTEGER、BIGINT、FLOAT、DECIMAL → 0;BOOLEAN → false。
  • DATE 输出 1970-01-01T00:00:00.000Z,DATEONLY 输出 1970-01-01,TIME 输出 00:00:00。
  • UUID 变成全零的 UUID 字符串,ENUM("admin", "user") 取第一个值,JSON/JSONB 变成空对象。
  • ARRAY(DataTypes.STRING) 按元素类型处理,VIRTUAL(DataTypes.STRING) 用内部类型填充。
  • 模型选项 timestamps: false、updatedAt: false、createdAt: "created_on" 和 paranoid: true 会添加、去掉或重命名日期属性。
  • 完整写法 { type: ..., allowNull: ... } 和简写 DataTypes.X 都能识别。

使用场景

起草 seeder 数据

编写 queryInterface.bulkInsert 的对象数组时以输出为起点,key 名和类型就能与模型一致。由数据库填充的 id 和时间戳请删掉。

阅读没有类型的遗留代码

没有 TypeScript 时,光看模型很难判断它会发送什么样的 JSON。把每个模型文件都放进来跑一遍,就能快速掌握 API 的响应结构。

注意事项与限制

  • 字面量形式的 defaultValue("pending"、1、true)会成为示例值。DataTypes.NOW、DataTypes.UUIDV4 或 sequelize.fn(...) 这类生成的默认值则退回到该类型的占位值。
  • hasMany、belongsTo 等关联写在模型定义之外,所以不会出现在输出中。用 include 加载的数据请手动添加。
  • 在 MySQL 和 PostgreSQL 上,DECIMAL 在运行时通常以字符串返回,但示例中显示为 0。
  • GEOMETRY 这类没有明显示例值的类型会变成 null。

常见问题

我设置了 underscored: true,为什么还是 createdAt 而不是 created_at?

underscored 只会把数据库列名改成 snake_case。toJSON() 使用的属性名仍是 createdAt,所以输出与之一致。如果也要改 JSON key,请用 createdAt: "created_at" 显式命名。

class User extends Model {} 和 User.init() 分开写也能用吗?

能。.init( 前面的标识符会用作模型名,第一个参数会作为属性映射读取。

TypeScript 装饰器模型在哪里转换?

带 @Table 和 @Column 的 sequelize-typescript 模型请使用 Sequelize (TS) 转 JSON 页面。那个页面读取的是属性类型,而不是 DataType。