使用 API Explorer

Looker API Explorer 是一个扩展程序,也就是使用 Looker 组件构建的 Web 应用,使用 Looker 扩展程序框架开发并通过 Looker Marketplace 部署。

API Explorer 提供了以下资源,供您与 Looker API 搭配使用:

用户无需登录即可使用扩展程序版本的 API Explorer,因为 API Explorer 会使用活跃用户的账号发出 API 请求。这样可以确保用户只能执行他们有权执行的 API 调用,同时无需提供 API 凭据。

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

安装 API Explorer

Looker Marketplace 提供 API Explorer。

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

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

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

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

如需了解如何从 Looker Marketplace 安装扩展程序,请参阅 Using the Looker Marketplace 文档页面。如需确保您始终使用的是最新版本的 API Explorer,请前往 Looker Marketplace,选择管理,然后选择该扩展程序旁边的更新按钮。

启动 API Explorer

安装 API Explorer 后,您可以从左侧边栏的应用部分导航到该工具。

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

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

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

    • 4.0 - 当前版本
  3. 选择比较规范按钮,打开 API 版本比较页面

  4. 搜索字段中输入搜索字词,即可将列出的方法类型限制为包含与您的搜索字词相匹配的文本的对象。

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

  5. 选择 Methods(方法)标签页以显示 API 方法类别。您可以展开或收起某个方法类别,以查看该类别中的各个方法。

  6. 选择 Types(类型)标签页以显示 API 类型。类型未分类,只是按字母顺序列出。

  7. 选择主菜单按钮以隐藏或显示 API Explorer 导航面板。

查看 API 方法和类型文档

方法标签页中选择某个方法类别后,该方法类别会展开,并显示该类别中的所有方法。

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

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

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

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

方法和类型声明

API Explorer 使用 SDK 语言选择器下拉菜单中选择的 SDK 语言呈现 SDK 方法和类型声明。如果 SDK 语言选择器设置为“全部”,系统会以所有支持的 SDK 语言显示方法和类型声明,并以制表符分隔。

SDK 示例

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

如果选择特定的 SDK 语言,则首先列出该语言的示例。

页面上可能还会显示 Ruby 和 Java 示例,但这些示例并不是 SDK 语言。

参考

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

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

API 浏览器包含一个 Run It 按钮,该按钮会打开一个面板,您可以通过该面板请求 API 调用,并以各种支持的格式显示响应。

选择 Run It 按钮后,API Explorer 会显示 Request 标签页,您可以在其中为 API 方法提供输入。

输入所需的输入,然后选择 Run 以执行 API 调用。

每当 API 方法可以更改数据时(对于任何 REST 调用,例如 POSTPATCHUPDATEDELETE),系统都会显示数据更改确认复选框,并且必须先选中该复选框,然后才能运行请求。

运行请求后,响应标签页会显示结果。

此外,代码标签页会显示在语言选择器下拉菜单中选择的 SDK 的 SDK 调用语法。如果 SDK 语言选择器设为全部,系统会以所有受支持的 SDK 语言显示 SDK 调用语法(以制表符分隔)。

回答显示类型

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

CSV 和其他表格数据

对于 CSV 和 JSON 数据,Looker 会执行形状测试,以确定数据是否符合表格条件。如果 Looker 确定载荷数据是表格数据,则响应的默认显示方式为数据网格。

选择原始标签页以显示未转换的数据。

JSON

JSON 载荷可以采用表格形式,在这种情况下,它们将显示在网格中。LookML 查询的列标题以 <view_name>.<field_name> 的形式显示,而不是显示字段的标签。

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

PNG 和 JPEG

PNG 和 JPEG 格式会显示为查询选择的可视化图表,并包括任何已应用的可视化图表设置。下例是上文中所示同一查询的 PNG 输出,但使用的是表格可视化结果。JPEG 的处理方式类似。

PNG 下载示例。

SVG

某些 Looker 端点会返回 SVG,系统也直接支持 SVG。以下是 SVG 格式的 content_thumbnail 端点示例,它会返回信息中心的抽象缩略图。

SVG 下载示例。

HTML

返回 HTML 源代码的请求会在响应标签页中显示 HTML 源代码。

文本

如果请求返回的 SQL 或其他格式被 MIME 类型化为纯文本,则会在响应标签页中显示为纯文本。

比较 API 版本

API Explorer 包含一个页面,可让您比较不同版本的 Looker API,以查看不同版本之间的变化。选择页面右上角的三角形 Compare Specifications(比较规范)按钮,以打开 API Explorer 比较页面。

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

  2. 选择要在对比项中添加的 API 选项,以过滤方法,仅过滤出在所选选项方面存在差异的方法。以下是各个选项:

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

  4. 选择某个方法以展开它,比较页面会显示差异,以显示该方法在不同版本之间的变化。