Looker API 4.0 正式发布

我们很高兴地宣布,Looker API 4.0 已在 Looker 22.4 中正式发布。正式版 API 4.0(API 4.0 GA)有多项重大变更和新增变更,并将多个端点从 Beta 版升级为稳定版。如需详细了解 API 4.0 规范,请参阅我们的 API 参考文档。我们更新了 Looker 支持和社区支持的 SDK,以支持 Looker API 4.0 GA 端点。如需了解详情,请参阅 API 和 SDK 支持政策API 版本控制。本文的其余部分概述了迁移到 API 4.0 GA 时会遇到的重大变更、缓解措施以及可期待的功能。

哪些人应阅读本文档?

如果您通过 Looker 支持的 SDK、社区支持的 SDK 或 Looker API 本身来使用 Looker API,那么本文档适合您阅读。请阅读与您使用的 Looker API 版本对应的以下部分。

预发布版 API 4.0 用户

如果您使用的是 API 4.0,请阅读本部分。本文介绍了迁移到 API 4.0 GA 时出现的重大变更以及可用的缓解措施。

API 4.0 GA 包括将所有实体 ID 字段从数字 integer 类型更改为 string 类型。例如,GET /groups/{group_id} 端点返回 id 作为类型 string 而不是类型 int64

请仔细阅读下表,了解 API 4.0 端点使用情况的具体影响和缓解措施:

用量 潜在影响1 预防措施
Looker 移动应用 过时的 Looker 移动应用安装版本将停止运行 让用户更新到最新版本的 Looker 移动应用
Looker 支持的 2 SDK
TypeScript SDK(4.0 版 API) 无影响 您无需执行任何操作
Python SDK(4.0 版 API) 无影响 您无需执行任何操作
Ruby SDK (4.0 API) 无影响 您无需执行任何操作
社区支持的 2 SDK
Swift SDK 运行时异常 将 SDK 更新到 v22.0 及更高版本;然后解决由此产生的类型错误(如有)
Kotlin SDK 无影响 您无需执行任何操作
LookR SDK 无影响 您无需执行任何操作
C# SDK 无影响 您无需执行任何操作
Go SDK 运行时异常 将 SDK 更新到 v22.0 及更高版本;然后解决由此产生的类型错误(如有)
其他
使用 4.0 API,但不使用 SDK(或使用外部提供的库) 可能会出现的运行时错误,具体取决于语言的类型敏感度 检查代码中是否存在对任何 ID 字段类型的依赖项,并添加对字符串类型 ID 字段的支持。另请参阅这份其他指南

1:假设采用的常见使用模式可能包括使用 Looker 的 ID 字段,但不包括不寻常的使用模式,例如对 ID 应用数值运算。

2:Looker API 和 SDK 支持。社区支持的库不受 Looker 的正式支持。

API 3.1 用户

如果您使用的是 API 3.1,请阅读本部分。本文档介绍了 API 4.0 为您提供的其他功能和变更。请注意,我们支持的所有 Looker SDK 和社区支持的 SDK 主要支持 API 4.0。如需了解详情,请参阅 SDK 和 API 支持政策

其他 API 4.0 正式版功能

为方便起见,我们为您列出了最值得注意且最有用的 API 4.0 增量变更:

API 4.0 正式版弃用变更

API 4.0 GA 用改进的功能替换了多个已弃用的 API 3.1 端点。以下端点会受到影响:

API 3.0 用户

API 3.0 已弃用,建议您迁移到 API 4.0。

  • 只有 API 4.0 支持所有 Looker 支持的 SDK 和社区支持的 SDK,从而简化您的开发工作。请参阅我们的 SDK 制品库
  • API 4.0 引入了多项新功能和增强功能,如本页面的其他 API 4.0 GA 功能部分中所列。

总结

我们将在 API 4.0 中添加新功能和增量变更,您随时可以在我们的 API 参考文档中找到最新变更。如需了解详情,请参阅 API 和 SDK 支持政策API 版本控制。我们知道,重大变更并非理想之选。除非出现极端问题,否则我们不会对正式版 API 4.0 进行任何重大变更。我们希望正式版 Looker API 4.0 能帮助您在 Looker 平台上更高效、更轻松地进行开发。