クエリのテスト

Version: 20.x
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

GraphQL IDE は、GraphQL クエリをアプリケーションで使用する前にテストするのに役立ちます。Preview API (Preview API IDE) と Delivery API (Delivery API IDE) をベースに構築され、スキーマの自動リロードなどの追加機能を備えた GraphQL IDE があります。Delivery IDE と Preview IDE を使用するには、API キーを作成する必要があります。

注記

GraphQL IDE は、Experience Edge がインストールされている場合にのみ使用できます。

Delivery API IDE を使用したクエリのテスト

Delivery API IDE は Delivery API を使用します。Delivery API は、配信プラットフォームでホストされる GraphQL API で、承認およびパブリッシュされたコンテンツへのアクセスのみを提供します。Delivery API へのすべての要求を API キーで認証する必要があります。API キーを作成する前に、OAuth を使用して JWT を取得します。

GraphQL エンドポイントへのアクセス権を取得したら、クエリを実行して、アクセスできるオブジェクトの種類やオブジェクトの属性のタイプなどを確認できます。Delivery API の IDE の URL は https://edge.sitecorecloud.io/api/graphql/ide です。

[en] An item query against the delivery API in the GraphQL IDE.

Preview API IDE を使用したクエリのテスト

Preview API IDE は、Delivery IDE と同じ機能を提供しますが、セルフホストされている Sitecore XM インスタンスで Preview API に対して実行されます。プレビュー エンドポイントのテスト UI を使用してクエリをテストできます。セルフホストされている Sitecore XM インスタンス上のプレビュー エンドポイント (/sitecore/api/graph/edge) は、既定で有効になっています。ただし、API キーを作成して GraphQL 要求で渡す必要があります。

クエリをテストするには、次の手順に従います。

  1. https://<your host>/sitecore/api/graph/edge/ui に移動します。

  2. UI の [HTTP ヘッダー] セクションで、sc_apikey ヘッダーを指定します。

    RequestResponse
    {
        "sc_apikey": "your-api-key-guid"
    }
    注記

    Sitecore サービス クライアントと Sitecore GraphQL もクエリ文字列を介して API キーを受け入れます。sc_apikey HTTP ヘッダーを使用すると Experience Edge の動作が反映されるため、この HTTP ヘッダーを使用することをお勧めします。

何かフィードバックはありますか?

この記事を改善するための提案がある場合は、