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 添加到某个锚点：

docs.json

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

在 docs.json 文件中按如下方式更新 tab 字段，将合并后的规范 URL 添加到标签页：

docs.json

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

由 Speakeasy 生成的代码片段现已可在你的 API 文档中查看，并可在演示环境中交互使用。