我们很高兴地宣布,Looker API 4.0 已在 Looker 22.4 中正式发布。正式版 API 4.0 (API 4.0 GA) 包含多项破坏性和补充性更改,并提升了从 Beta 版到稳定版本的多个端点。API 3.1 和 3.0 不受影响。如需详细了解详细的 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,请参阅此部分。介绍了从 Looker 22.4 迁移到 API 4.0 GA 时的重大变更和可用的缓解措施。
API 4.0 正式版包括将所有实体 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 主要支持 API 4.0。如需了解详情,请参阅我们的 SDK 和 API 支持政策。
其他 API 4.0 正式版功能
为方便起见,我们列出了其中最重要、最有用的附加 API 4.0 变化:
- 白板、白板项和白板部分创建和管理。板级文档位于此处。
- 查询其他连接信息,例如数据库、架构、列和表。设置并更新其他连接字段。
- OAuth 应用以及用户创建和管理。OAuth 文档位于此处。
- 搜索包含层次结构和角色的群组。
- 设有用户数量的搜索角色。
- 获取和设置 Looker 实例设置。您可以点击此处查看设置文档。
- 提醒创建和管理。如需提醒文档,请点击此处。
- SSH 隧道和 SSH 服务器创建、管理和测试。如需查看 SSH 文档,请点击此处。
- 移动和复制信息中心。
- 获取新信息中心的相对网址。
- 移动和复制外观。
- 单点登录和非单点登录嵌入密钥、网址以及用户创建和管理。
- 获取刷新令牌以刷新登录访问令牌。
- 限制并获取所有 LookML 模型和所有用户的结果。
- 限制和偏移搜索用户的结果。
- 在 Swagger 2.x JSON 中获取 Looker 实例 API 规范。
API 4.0 正式版弃用变更
API 4.0 正式版将多个已弃用的 API 3.1 端点替换为经过改进的功能。我们在下面列出了受影响的端点:
API 3.0 用户
如果您使用的是 API 3.0,请参阅此部分。请注意,API 3.0 被视为旧版,已弃用,我们不建议使用。建议您迁移到 API 4.0。
- 只有 API 4.0 支持所有受 Looker 支持和社区支持的 SDK,可简化开发。查看我们的 SDK 代码库。
- API 4.0 中引入了上述新功能和增强功能。
小结
您可以期待将新功能和新增更改添加到 API 4.0 中,并且随时可以在我们的 API 参考文档中找到最新更改。如需了解详情,请参阅我们的 API 和 SDK 支持政策以及我们的 API 版本。我们知道,破坏性更改并不理想。除非出现极端问题,否则我们不会对正式版 API 4.0 进行任何破坏性更改。我们希望正式版 Looker API 4.0 可以帮助您在 Looker 平台上更高效、更轻松地开发应用。