JSON.CN让代码更轻
JSON 整理与类型生成可运行案例

Webhook 事件：从接口样本生成 TypeScript 类型草稿

根据 Webhook 事件 的两条样本推断嵌套对象和数组类型。生成声明不会在运行时校验接口响应；可选字段、枚举和完整业务合同仍需人工确认。编号保持字符串。

浏览器本地处理合成数据同场景 32 个案例 ↗
试一试

示例工作台

在完整工具中打开 ↗
JSON 整理与类型生成修改下方数据后重新运行
运行结果
// 根据样本推断；必填、枚举、业务约束需结合接口合同确认。
export type ExampleResponse = {
  "ok": boolean;
  "data": {
    "events": ({
      "eventId": string;
      "eventName": string;
      "attempt": number;
      "delivered": boolean;
      "eventType": string;
      "payload": {
        "resourceId": string;
        "changes": (string)[];
      };
    })[];
    "summary": {
      "total": number;
      "note": null;
    };
  };
};

原例已核验，可修改输入后重新运行。

⌘ / Ctrl + Enter 运行
01

场景与操作说明

Webhook 事件的投递次数与资源变更内容属于不同层级。此案例只检查事件样本，不向回调地址发送请求，也不证明签名或幂等逻辑正确。

attempt 是演示投递次数，delivered 仅表示样本中的布尔值。

  1. 核对 Webhook 事件 的字段层级，保留 eventId 的字符串类型。
  2. 修改一项输入并运行，观察结果中的值或路径如何变化。
  3. 载入对照样本，复现下面的变化；恢复原例会替换当前输入。
02

对照样本

对照样本的 events 为空数组，没有提供元素类型证据。生成结果不能据此证明真实接口永远返回空数组。

查看对照输入
{
  "ok": true,
  "data": {
    "events": [],
    "summary": {
      "total": 2,
      "note": null
    }
  }
}

对照样本的实际结果

// 根据样本推断；必填、枚举、业务约束需结合接口合同确认。
export type ExampleResponse = {
  "ok": boolean;
  "data": {
    "events": (unknown)[];
    "summary": {
      "total": number;
      "note": null;
    };
  };
};