Speakeasy

在 API 操作台中自动生成 SDK 使用代码片段

来自 Speakeasy SDK 的自动生成代码片段可以直接集成到 Mintlify 的 API 参考文档中。SDK 使用代码片段会显示在由 Mintlify 驱动的文档站点的交互式操作台中。

前置条件

要将 Mintlify 与 Speakeasy 集成，你需要准备：

• 一个 Mintlify 文档仓库。
  • 一个由 Speakeasy 生成并已配置自动代码示例 URL 的 SDK。

设置集成

要将 Speakeasy 与 Mintlify 集成，你需要从注册表获取该 API 的合并规范的公共 URL，并更新你的 docs.json 配置文件。

从注册表获取 API 合并规范的公共 URL

前往你的 Speakeasy 控制台，打开 API Registry 选项卡。打开该 API 的 *-with-code-samples 条目。

如果该条目未标记为 Combined Spec，请确认该 API 已配置自动代码示例 URL。

在该注册表条目的页面中，复制提供的公共 URL。

更新你的 docs.json 配置文件

将合并后的规范 URL 添加到 docs.json 文件中的 Anchors 或 Tabs 部分。

在 docs.json 中更新 anchor 字段，将合并后的规范 URL 添加到一个 anchor，如下所示：

docs.json

{
  "anchors": [
    {
      "name": "API Reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL",
      "url": "api-reference",
      "icon": "square-terminal"
    }
  ]
}

在 docs.json 中更新 tab 字段，将合并后的规范 URL 添加到一个 tab，如下所示：

docs.json

{
  "tabs": [
    {
      "name": "API Reference",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}

现在，你可以在 API 文档中查看由 Speakeasy 生成的代码片段，并在 API 操作台中进行交互。