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

全文检索结果:从接口样本生成 TypeScript 类型草稿

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

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

示例工作台

在完整工具中打开 ↗
JSON 整理与类型生成修改下方数据后重新运行
运行结果
// 根据样本推断;必填、枚举、业务约束需结合接口合同确认。
export type ExampleResponse = {
  "ok": boolean;
  "data": {
    "hits": ({
      "documentId": string;
      "title": string;
      "score": number;
      "highlighted": boolean;
      "documentType": string;
      "match": {
        "snippets": (string)[];
        "fields": (string)[];
      };
    })[];
    "summary": {
      "total": number;
      "note": null;
    };
  };
};

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

⌘ / Ctrl + Enter 运行
01

场景与操作说明

全文检索结果包含文档标识、分数、类型和命中的文本片段。下面的指南与参考文档各有命中字段列表,可练习提取标题、保留结果顺序和比较评分类型;分数只在同一查询口径下解释。

score 为演示非负整数,不能当作跨查询可比较的绝对质量评分。

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

对照样本

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

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

对照样本的实际结果

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