很高興在此宣布,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 或 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}
端點會以 string
類型傳回 id
,而非 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 更新至 22.0 以上版本,然後解決產生的類型錯誤 (如有) |
Kotlin SDK | 沒有影響 | 無須採取行動 |
LookR SDK | 沒有影響 | 無須採取行動 |
C# SDK | 沒有影響 | 無須採取行動 |
Go SDK | 執行階段例外狀況 | 將 SDK 更新至 22.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 加法變更:
- 建立及管理看板、看板項目和看板專區。如要進一步瞭解看板,請參閱看板說明文件頁面。
- 查詢其他連線資訊,例如資料庫、結構定義、欄和資料表。設定及更新其他連線欄位。
- 建立及管理 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 存放區。
- API 4.0 推出了多項新功能和改善項目,請參閱本頁的「其他 API 4.0 GA 功能」一節。
總結
您可以期待 API 4.0 新增的新功能和附加變更,並隨時在 API 參考資料中查看最新變更。詳情請參閱「API 和 SDK 支援政策」和「API 版本管理」。我們瞭解破壞性變更並非理想做法。除非發生極端問題,否則我們不會對正式發布版 API 4.0 進行任何重大變更。我們希望 Looker API 4.0 正式版能協助您在 Looker 平台上更有效率、更輕鬆地進行開發。