使用 API Explorer

Looker API Explorer 是一个扩展程序(一种使用 Looker 组件构建的 Web 应用),它使用 Looker 扩展程序框架开发,并通过 Looker Marketplace 进行部署。

API Explorer 提供以下资源:

用户无需登录获取 API Explorer 的扩展程序版本,因为 API Explorer 使用活跃用户的 API 请求处理 API 请求。这样可确保用户只能执行他们有权使用的 API 调用,同时也无需提供 API 凭据。

Looker 的 sudo as another user 功能也可用于以其他用户身份发出 API 请求,以帮助诊断访问权限问题。

安装 API Explorer

API Explorer 可在 Looker 市场中获取。

在从 Marketplace 安装 API Explorer 之前,Looker 管理员必须启用扩展程序框架功能。

若要安装 Marketplace 中的应用(例如 API Explorer 扩展程序),您必须拥有 developmanage_modelsdeploy 权限。API Explorer 安装完毕后,任何对 extension_api_explorer 模型至少拥有 access_data 权限的用户都可以使用 API Explorer。每个用户都可以查看 API Explorer 中的所有 API 端点,但只能运行其权限允许的端点。

如果您的 Looker 管理员在 Looker 的管理菜单的平台部分市场页面中启用了自动安装选项,API 资源管理器将自动安装到您的实例上。此外,只要有可用更新,这些更新将自动应用,从而确保您实例的 API Explorer 版本为最新版本。

如果您的 Looker 管理员尚未启用自动安装选项,您将需要从 Looker Marketplace 安装 API Explorer。

如需了解如何通过 Looker Marketplace 安装扩展程序,请参阅使用 Looker Marketplace 文档页面。您可以通过以下方式来确保始终使用最新版本的 API Explorer:转到 Looker Marketplace,点击管理,然后点击该扩展程序旁边的更新按钮。

启动 API Explorer

安装 API Explorer 后,您可以通过以下方式导航到它:

  1. 浏览菜单已安装应用和扩展程序的列表

  2. 应用与工具页(可从浏览菜单和左侧边栏中访问)

  3. 如果您是 Looker 管理员,还可以点击 Looker 的 API 管理页面上的使用 API Explorer 链接来访问 API Explorer。

在 API Explorer 首页上,您可以执行以下任务:

  1. 使用 SDK 语言选择器下拉菜单选择 API Explorer 用于显示编程语言的编程语言、类型声明以及代码结果。选择器在初始加载时默认使用 Python。如果您从语言选择器中选择全部,则 API Explorer 会显示每种受支持语言的标签页式视图。

  2. 使用版本下拉菜单选择 API 版本:

    - 4.0 - 当前版本

从 Looker 22.4 开始,Looker API 4.0 已全面推出。在此版本中,API 3.1 已被弃用,并且已从 API Explorer 中移除,这使得 API 4.0 成为了唯一可在 API Explorer 中查看的版本。虽然将来的版本仍存在 API Explorer 比较页面,但该 API 目前仍无法正常工作,因为 API 4.0 是唯一可用的版本。

  1. 搜索字段中输入搜索字词,将列出的方法类型限制为仅使用包含与搜索字词匹配的文字的公式:

    当您选择搜索返回的方法或类型时,搜索字词会在方法或类型摘要中突出显示。

  2. 选择方法标签页,以显示 API 方法类别。您可以展开或收起方法类别,以查看相应类别中的各个方法。

  3. 选择类型标签页,以显示 API 类型。类型未分类,按字母顺序排列。

  4. 点击三条横线图标可隐藏或显示 API Explorer 导航面板。

查看 API 方法和类型文档

方法标签页中选择方法类别后,系统会展开该方法类别,并显示该类别中的所有方法:

  1. 在主面板中,系统会显示该类别中的所有方法。您可以选择显示类别中的所有方法,也可以点击特定方法类型的标签页,以将列表过滤为仅显示该方法类型。

  2. 如需查看特定方法的文档,请在导航面板中选择方法名称,或在主面板中点击方法。

选择特定方法后,API Explorer 将显示该方法的文档:

类型标签页中选择一种类型后,该类型对应的文档会显示在主面板中:

方法和类型声明

API Explorer 会根据从 SDK 语言选择器下拉列表中选择的 SDK 语言呈现 SDK 方法和类型声明。如果 SDK 语言选择器设置为 All,则方法和类型声明会以所有受支持的 SDK 语言显示,并以制表符分隔:

SDK 示例

Looker sdk-codegen 代码库有一个包含 Looker SDK 示例的文件夹。如果 sdk-codegen 代码库包含某个方法的示例,则该方法的 API Explorer 页面将显示 SDK 示例部分,其中包含指向示例的链接。

如果选择了特定的 SDK 语言,系统会先列出该语言的示例。例如,以下 SDK 示例表格将 Swift 显示为选定的语言:

系统可能还会显示 Ruby 和 Java 示例,但这些示例不是 SDK 语言。

引用

每个方法和类型的引用部分都包含原始方法或类型引用的各个方法或类型的 API Explorer 页面的链接:

使用 Run It 请求和显示 API 调用

API Explorer 包含一个 Run It 按钮,点击该按钮可打开一个面板,您可以在其中请求 API 调用并以各种受支持的格式显示响应:

点击运行按钮时,API Explorer 会显示一个请求标签页,您可以在其中向 API 方法提供输入:

输入所需的输入,然后点击运行以执行 API 调用。

每当 API 方法可以更改数据(对于任何属于 POSTPATCHUPDATEDELETE 的 REST 调用)时,系统都会显示数据更改确认复选框,并且在执行请求之前必须选中该复选框。

运行请求时,Response 标签页会显示结果:

此外,Code 标签页还会显示从语言选择器下拉列表中选择的 SDK 的 SDK 调用语法。如果 SDK 语言选择器设置为 All,则 SDK 调用语法会以所有受支持的 SDK 语言显示,并以制表符分隔:

响应显示类型

API Explorer 响应包含一个 MIME 类型,用于确定如何显示结果。

CSV 和其他表格数据

对于 CSV 和 JSON,执行简单的“形状”测试,以确定数据是否看起来像是表格。如果载荷数据确实像表,则响应的默认显示对象为数据网格:

Raw 标签页可用于显示未转换的数据:

JSON

JSON 载荷可以是“表格形式的”载荷,在这种情况下,它们将以网格形式显示。JSON 格式的 LookML 查询的列标题与 CSV 格式的列标题不同:

复杂的 JSON 载荷省略了网格显示,仅显示原始 JSON:

PNG 和 JPEG

以下是上述同一查询的示例(以 PNG 格式呈现)。JPEG 的处理方式类似:

SVG

某些 Looker 端点会返回 SVG,这也是直接受支持的。以下是 SVG 格式的 content_thumbnail 端点示例:

HTML

响应标签页中会突出显示 HTML 源代码:

文字

MIME 类型为纯文本的 SQL 和其他响应如下所示:

比较 API 版本

从 Looker 22.4 开始,Looker API 4.0 已全面推出。在此版本中,API 3.1 已被弃用,并且已从 API Explorer 中移除,这使得 API 4.0 成为了唯一可在 API Explorer 中查看的版本。虽然将来的版本仍存在 API Explorer 比较页面,但该 API 目前仍无法正常工作,因为 API 4.0 是唯一可用的版本。

API Explorer 包含一个页面,您可以通过该页面比较不同版本的 Looker API,并查看版本之间的变化。点击页面右上角的三角形以打开 API Explorer 比较页面。

  1. 选择 API 的基本版本以及要与基本版本进行比较的 API 版本。

  2. 选择您要在对比项中包含的 API 选项,以便过滤所选方法,使它们仅显示所选选项存在差异的方法。以下是各个选项:

    • 缺失 - 显示 API 的一个版本中存在且另一个版本中缺失的所有方法。
    • Status - 显示方法状态发生更改的所有方法。例如,状态从 beta 更改为 stable 的方法。
    • Parameters - 显示一个或多个方法参数发生更改的所有方法。
    • 类型 - 显示具有新属性、已移除属性或更改的属性的类型。
    • 正文 - 显示正文参数的更改。
    • 响应 - 显示方法响应发生更改的所有方法。
  3. 比较页面会显示存在差异的方法数量,并列出了存在差异的方法。

  4. 点击某个方法将其展开,比较页面将显示一个差异,说明该方法在版本之间有何变化。