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 和社区支持的 SDK,以支持 Looker API 4.0 GA 端点。如需了解详情,请参阅 API 和 SDK 支持政策以及 API 版本控制。本文的其余部分简要介绍了迁移到 API 4.0 GA 时您可以期待的重大变更、缓解措施和功能。

哪些人应阅读本文?

如果您通过 Looker 支持的 SDK、社区支持的 SDK 或 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} endpoint 会将 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 或更高版本;然后解决由此产生的类型错误(如果有)
其他
在不使用 SDK(或使用外部提供的库)的情况下使用 4.0 API 可能出现的运行时错误,具体取决于语言的类型敏感性 检查代码是否依赖于任何 ID 字段的类型,并添加对字符串类型 ID 字段的支持。另请参阅这份其他指南

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

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

API 3.1 用户

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

API 4.0 GA 版的其他功能

为方便起见,我们列出了 API 4.0 中最重要的增补性变更:

API 4.0 GA 废弃变更

API 4.0 GA 使用经过改进的功能替换了多个已废弃的 API 3.1 端点。受影响的端点如下:

API 3.0 用户

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

总结

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