Speakeasy

APIプレイグラウンドでSDK使用スニペットを自動生成

Speakeasy SDKで自動生成されたコードスニペットは、MintlifyのAPIリファレンスに直接統合できます。SDKの使用例スニペットは、Mintlifyで構築されたドキュメントサイトのインタラクティブなAPIプレイグラウンドに表示されます。

前提条件

Mintlify を Speakeasy と連携するには、以下が必要です：

• Mintlify のドキュメントリポジトリ
  • 自動コードサンプル URL が設定された、Speakeasy で生成した SDK

統合の設定

Speakeasy を Mintlify に統合するには、レジストリから API の結合済み仕様の公開 URL を取得し、docs.json 設定ファイルを更新します。

レジストリから API の統合仕様の公開 URL を取得する

Speakeasy Dashboard に移動し、API Registry タブを開きます。API の *-with-code-samples エントリを開きます。

エントリに Combined Spec と表示されていない場合は、API に automatic code sample URL が設定されていることを確認してください。

レジストリのエントリページで、表示されている公開 URL をコピーします。

docs.json 構成ファイルを更新する

結合された仕様のURLを、docs.json ファイル内の Anchors または Tabs セクションに追加します。

アンカーに結合済み仕様のURLを追加するには、docs.json ファイルの anchor フィールドを次のように更新します:

docs.json

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

タブに結合済み仕様のURLを追加するには、docs.json ファイルの tab フィールドを次のように更新します:

docs.json

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

Speakeasy で生成されたコードスニペットは、APIドキュメント内で表示でき、プレイグラウンドで操作できます。