Speakeasy

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

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

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

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

前往你的 Speakeasy 控制台，打开 API Registry 标签页。打开该 API 的 *-with-code-samples 条目。

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

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

在 docs.json 文件中按如下方式更新 anchor 字段，将合并后的规范 URL 添加到对应锚点：

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

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

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

现在，你可以在 API 文档中查看 Speakeasy 生成的代码片段，并在演示区中与它们交互。

重新部署文档后，打开 API 参考中的任一端点，确认在演示区中显示了各语言的代码片段。可用语言的范围与你在 Speakeasy 项目中配置的 SDK 目标一致。

如果代码片段未显示，请检查：

• docs.json 中的 openapi URL 指向 *-with-code-samples 组合规范条目，而不是源 OpenAPI 文件。
• 组合规范的 URL 可以从浏览器公开访问。
• 你的 Speakeasy 项目已配置自动生成的代码示例 URL，并至少启用了一个 SDK 目标。