我们很高兴地宣布,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 GA 前用户
如果您使用 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+;然后解决由此产生的类型错误(如果有) |
| 其他 | ||
| 在没有 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 和社区支持的 SDK 主要支持 API 4.0。如需了解详情,请参阅 SDK 和 API 支持政策。
其他 API 4.0 GA 功能
为方便起见,我们列出了最值得注意且最有用的新增 API 4.0 变更:
- 创建和管理面板、面板项和面板部分。如需详细了解面板,请参阅面板文档页面。
- 查询其他连接信息,例如数据库、架构、列和表。设置和更新其他连接字段。
- 创建和管理 OAuth 应用和用户。如需详细了解 OAuth,请参阅OAuth 文档页面。
- 按层次结构和角色搜索群组。
- 按用户数搜索角色。
- 获取和设置 Looker 实例设置。如需详细了解设置,请参阅设置文档页面。
- 创建和管理提醒。如需详细了解提醒,请参阅提醒文档页面。
- 创建、管理和测试 SSH 隧道和 SSH 服务器。如需详细了解 SSH,请参阅SSH 文档页面。
- 移动和复制信息中心。
- 获取新信息中心的相对网址。
- 移动和复制 Look。
- 已签名的嵌入和未签名的嵌入密钥、网址和用户创建和管理。
- 获取刷新令牌以刷新登录访问令牌。
- 限制和偏移获取 所有 LookML 模型 和 所有用户 的结果。
- 限制和偏移搜索用户的结果。
- 以 Swagger 2.x JSON 格式获取 Looker 实例 API 规范。
API 4.0 GA 弃用变更
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 平台上更高效、更轻松地进行开发。