我们很高兴地宣布,Looker 22.4 现已正式推出 Looker API 4.0。正式版 API 4.0(API 4.0 正式版)包含多项破坏性更改和新增更改,并将多个端点从 Beta 版升级为稳定版。如需查看详细的 API 4.0 规范,请查看我们的 API 参考。我们更新了由 Looker 支持和由社区支持的 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 正式版后发生的重大变化和可用的缓解措施。
API 4.0 正式版包括将所有实体 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 正式版功能
为方便起见,我们为您列出了最值得注意且最实用的 API 4.0 新增更改:
- 创建和管理看板、看板项和看板版块。如需详细了解开发板,请参阅开发板文档页面。
- 查询其他连接信息,例如数据库、架构、列和表。设置和更新其他连接字段。
- OAuth 应用及用户创建和管理。如需详细了解 OAuth,请参阅 OAuth 文档页面。
- 搜索具有层次结构和角色的群组。
- 搜索角色及用户数。
- 获取和设置 Looker 实例设置。如需详细了解设置,请参阅“设置”文档页面。
- 创建和管理提醒。如需详细了解提醒,请参阅提醒文档页面。
- SSH 隧道和 SSH 服务器的创建、管理和测试。如需详细了解 SSH,请参阅 SSH 文档页面。
- 移动和复制信息中心。
- 获取新信息中心的相对网址。
- 移动和复制 Look。
- 签名嵌入和非签名嵌入密钥、网址以及用户创建和管理。
- 获取刷新令牌以刷新登录访问令牌。
- 对获取所有 LookML 模型和所有用户的结果进行限制和偏移。
- 对搜索用户的结果进行限制和偏移。
- 获取 Swagger 2.x JSON 格式的 Looker 实例 API 规范。
API 4.0 正式版弃用变更
API 4.0 正式版用改进的功能取代了几个已弃用的 API 3.1 端点。以下端点会受到影响:
- 移除了已弃用的首页端点。请使用板级端点,而不是首页。请参阅使用面板展示内容。
- 移除了已弃用的聊天室端点。使用文件夹端点(而非聊天室)。请参阅整理和管理对内容的访问权限。
API 3.0 用户
API 3.0 已弃用,建议您迁移到 API 4.0。
- 只有 API 4.0 支持所有 Looker 支持和社区支持的 SDK,以简化开发工作。查看我们的 SDK 代码库。
- API 4.0 引入了多种新功能和增强功能,本页的“其他 API 4.0 正式版功能”部分已列出这些功能。
总结
我们期待为 API 4.0 添加新功能和新增更改,并随时在 API 参考中找到最新更改。如需了解详情,请参阅 API 和 SDK 支持政策以及 API 版本控制。我们知道,破坏性更改并不理想。除非出现极端问题,否则我们不会对正式版 API 4.0 进行任何破坏性更改。我们希望正式发布的 Looker API 4.0 可以帮助您在 Looker 平台上更高效、更轻松地进行开发。