API Explorerタブ
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore SearchのDeveloper ResourcesページのAPI Explorerタブは、開発者が自分のデータに対してリクエストを作成・実行する場所です。これは検索およびrecommendation APIを活用したライブかつインタラクティブな方法です。このトピックでは、このツールを活用できる多くの方法について説明します。
API Explorerタブは、Builderペイン、Requestペイン、Responseペインの3つのペインに分かれています。
建設
ビルドペインでAPIリクエストの値を入力または選択できます。
Sitecore Search実装は、各ページに要件を満たすウィジェットがあるページ向けに設定されています。ページに設定されたURLまたはURLパターンがその内容を決定します。ページを選択すると、その設定済みのURLやURLパターンが ビルド ペインのURL入力フィールドに設定されます。
!注API Explorerはウィジェットがページに含まれていないためAPIリクエストpreview search作成できません。 Buildはページに対してのみAPIリクエストを構築できます。
リクエストを見るには 「ビルド」をクリックしてください。リクエストはRequestペインに表示されます。
Request
このペインでは、リクエストがJSON形式で表示されます。このペインでJSONを直接編集できます。
以下のコードはリクエストの例です。
{ "context": { "page": { "uri": "/search" }, "user": { "user_id": "12145" } }, "widget": { "rfkid": "rfkid_7" }, "content": { "product": {} } }
!注エラーは、リクエストにクエリに関連する値が欠けている場合に設定または更新すべき値を示します。
Click 
はパネルの右上にあり、サイズを大きくします。
リクエストをエクスポートするには、「 クリップボードにコピー」 をクリックし、以下のオプションから選択してください:
- Sitecoreホストを使ってcURLとしてコピーしてください
- サブドメインを使ってcURLとしてコピーしてください
- コードで使用するデータオブジェクトとしてコピーしてください。
リクエストをテストするには 、「実行」をクリックしてください。応答は 「応答 」ペインに表示されます。
!重要検索体験を妨げないため、APIは決して失敗しないように設計されています。常に利用可能な情報に基づいて次に良い結果を返します。
反応
リクエストへのJSON応答はこのペインに表示されます。JSONを折りたたんで展開することで構造を確認し、レスポンスを検証できます。回答をエクスポートするには、「 クリップボードにコピー」 をクリックし、その後「 データオブジェクトとしてコピー」をクリックします。