Looker API Explorer 是一款扩展程序,它是一个使用 Looker 组件构建的 Web 应用,它使用 Looker 扩展程序框架开发,并通过 Looker Marketplace 进行部署。
API Explorer 提供以下资源:
- 所有 Looker API 方法和类型的文档
- 所有受支持的 SDK 语言中的方法和类型声明
- 指向使用 API 方法的示例 SDK 函数的链接
- 参考方法和类型的 API Explorer 页面链接
- 一个 Run It 函数,让您可以直接执行 API 调用,并提供 API 调用、API 响应和 SDK 函数的代码
- 一个对比工具,显示 Looker API 版本之间的差异
API Explorer 的扩展程序版本无需用户登录,因为 API Explorer 使用的是活跃用户的 API 请求。这样可确保用户只能执行他们有权使用的 API 调用,同时还无需提供 API 凭据。
还可以使用 Looker 的 sudo as a user 功能以其他用户的身份发出 API 请求,以帮助诊断访问问题。
安装 API Explorer
API Explorer 可以在 Looker 市场中使用。
在从 Marketplace 安装 API Explorer 之前,Looker 管理员必须启用扩展框架功能。
若要安装 Marketplace 中的应用(例如 API Explorer 扩展程序),您必须具备 develop
、manage_models
和 deploy
权限。API 浏览器安装完毕后,任何对 extension_api_explorer
模型至少拥有 access_data
权限的用户都可以使用 API Explorer。每个用户都可以在 API Explorer 中查看所有 API 端点,但只能运行他们的权限所允许的端点。
如果您的 Looker 管理员在 Looker 的管理菜单的平台部分的市场页面中启用了自动安装选项,您的实例上将自动安装 API Explorer。此外,只要有可用更新,系统就会自动应用这些更新,从而确保您实例的 API Explorer 版本是最新版本。
如果您的 Looker 管理员尚未启用自动安装选项,您需要在 Looker Marketplace 中安装 API Explorer。
请参阅使用 Looker Marketplace 文档页面,了解如何通过 Looker Marketplace 安装扩展程序。您可以确保始终使用最新版本的 API Explorer,方法是前往 Looker Marketplace,选择管理,然后选择扩展程序旁边的更新按钮。
启动 API Explorer
安装 API Explorer 后,您可以从左侧边栏的应用部分导航到该浏览器。
在 API Explorer 中导航
在 API Explorer 的首页上,您可以执行以下任务:
使用 SDK 语言选择器下拉菜单选择 API Explorer 用于显示 API 方法和类型声明以及代码结果的编程语言。选择器在初始加载时默认为 Python。如果您从语言选择器中选择全部,API Explorer 会为每种支持的语言显示标签式视图。
使用版本下拉菜单来选择 API 版本:
- 4.0 - 当前版本
- 3.1 - 旧版
选择比较规范按钮,打开 API 版本比较页面。
在搜索字段中输入搜索字词,将列出的方法和类型限制为仅包含与搜索字词匹配的文字。
当您选择搜索返回的方法或类型后,相应方法或类型摘要便会在方法或类型摘要中突出显示。
选择方法标签页以显示 API 方法类别。您可以展开或收起某个方法类别,以查看该类别中的各个方法。
选择类型标签页,以显示 API 类型。类型未分类,按字母顺序排列。
选择主菜单按钮以隐藏或显示 API Explorer 导航面板。
查看 API 方法和类型文档
当您在 Method 标签页中选择方法类别后,方法类别便会展开,并显示该类别中的所有方法。
该类别中的所有方法都会显示在主面板中。您可以选择显示类别中的所有方法,也可以选择特定方法类型的标签页来过滤列表,仅显示相应方法类型。
要查看特定方法的文档,请在导航面板中选择方法名称,或在主面板中选择方法。
选择特定方法后,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 Explorer 包含一个运行按钮,点击此按钮可打开一个面板,供您请求 API 调用以及以各种支持的格式显示响应。
选择运行按钮后,API Explorer 会显示一个请求标签页,您可以在其中为 API 方法提供输入。
输入所需的输入,然后选择运行以执行 API 调用。
每当 API 方法可以更改数据(对于任何
POST
调用、PATCH
、UPDATE
或DELETE
)时,系统都会显示数据更改确认复选框,并且在运行请求之前必须选中该复选框。
请求运行时,响应标签页会显示结果。
此外,Code 标签页还会显示在语言选择器下拉菜单中选择的 SDK 的 SDK 调用语法。如果 SDK 语言选择器设置为全部,则 SDK 调用语法会以所有受支持的 SDK 语言显示,并以制表符分隔。
响应显示类型
API Explorer 响应包含一个 MIME 类型,用于确定如何显示结果。
CSV 和其他表格数据
对于 CSV 和 JSON 数据,Looker 会执行形状测试,以确定数据是否符合表格的条件。如果 Looker 确定载荷数据是表格式,则响应的默认显示对象为数据网格。
选择 Raw 标签页以显示未转换的数据。
JSON
JSON 载荷可能采用表格形式,在这种情况下,它们将在网格中显示。LookML 查询的列标题以 <view_name>.<field_name>
形式显示,而不是显示字段的标签。
复杂的 JSON 载荷会忽略网格显示内容,仅显示原始 JSON。
PNG 和 JPEG
PNG 和 JPEG 格式会显示为查询选择的可视化图表,并包括所有已应用的可视化设置。下一个示例是之前显示的同一查询的 PNG 输出,只是使用了表格可视化。JPEG 的处理方式类似。
SVG
某些 Looker 端点会返回 SVG,该工具也受直接支持。下面是一个 SVG 格式的 content_thumbnail
端点示例,它会返回信息中心的抽象缩略图。
HTML
返回 HTML 源代码的请求会在响应标签页中显示来源 HTML。
文本
如果请求返回 SQL 或其他 MIME 类型是纯文本格式的请求,则它们会在响应标签页中显示为纯文本。
比较 API 版本
在 API Explorer 中,您可以通过该页面比较不同版本的 Looker API,以查看不同版本之间发生的变化。选择位于页面右上角的三角形比较规范按钮,以打开 API Explorer 比较页面。
选择该 API 的基本版本以及要与基本版本的 API 版本。
选择您要在对比项中包含的 API 选项,仅过滤在所选选项方面存在差异的那些方法。以下是各个选项:
- 缺失 - 显示某个 API 版本中存在且在另一个 API 中缺失的所有方法。
- Status - 显示方法状态发生更改的所有方法。例如,状态从
beta
更改为stable
的方法。 - Parameters - 显示一个或多个方法参数发生更改的所有方法。
- 类型 - 显示具有新属性、已移除属性或已更改属性的类型。
- 正文 - 显示对正文参数的更改。
- Response - 显示方法响应中发生更改的所有方法。
比较页面会显示存在差异的方法数量,并会列出存在差异的方法。
选择某个方法即可将其展开,比较页面中会显示方法差异,说明该方法在各版本之间有何变化。