JSS GraphQL API

Version: 22.x

日本語翻訳に関する免責事項

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

Sitecore JavaScript Rendering S SDK (JSS) は、GraphQLによるデータのクエリと更新を容易にするGraphQLサービスとクライアントを提供します。

Sitecoreが提供するJSSプロジェクトを作成するためのツールを使用してアプリケーションを設定するときに、GraphQLの使用を選択できます。

大事な

GraphQLが機能するには、接続モード、ヘッドレス接続モード、または統合モードが必要です。非接続モードを使用する場合、非接続開発サーバーはRESTサービスのみをエミュレートするため、アプリケーションのサービス・ファクトリーはRESTサービスを返す必要があります。

GraphQLクエリに利用できるデータ

GraphQLを使用して、次の種類のデータを取得できます。

JSS Layout APIが提供するGraphQLレイアウトサービスを使用したレイアウトデータ。
JSS Dictionary APIが提供するGraphQL Dictionary Serviceを使用したディクショナリデータ。

JSS for Cisco Next.jsを使用している場合、サンプルアプリケーションはGraphQL Sitemap Serviceを利用して、Next.jsアプリを静的に生成およびエクスポートするときに、Sitecore GraphQL APIを使用してサイトページの一覧をフェッチします。

GraphQLエンドポイント

JSSアプリケーションは、次のGraphQLエンドポイントを使用できます。

Sitecore Experience Edge for XM GraphQLエンドポイント。読み取り専用のGraphQLスキーマが付属しており、ヘッドレスSitecore開発の一般的なフロントエンドのユースケースに対応するように設計されています。Experience Edgeスキーマについてお読みください。
Sitecore Edgeプレビューヘッドレスサービスによって提供されるGraphQLエンドポイントで、Experience EdgeスキーマをミラーリングするSitecore上のGraphQLサーバーの実装です。
JSS Server Componentsによって導入された史上初の1 Sitecore GraphQLエンドポイントであるSitecore GraphQLエンドポイント、またはSitecore GraphQL APIで作成されたカスタムエンドポイント

構成

Sitecoreが提供するJSSプロジェクトの作成ツールを使用してJSSアプリケーションを作成し、データフェッチ方法としてGraphQLを選択した場合、JSSサービスはSitecore Edge Preview GraphQLエンドポイントを使用します。

アプリケーションで使用されるGraphQLエンドポイントを変更するには:

JSSアプリケーションのルートディレクトリ、package.jsonファイル、configマップで、graphQLEndpointPathプロパティを見つけて更新します。

JSSアプリケーションでのGraphQLの使用

JSSアプリには、GraphQLの使用に関していくつかの選択肢があります。

JSSなしで構築されたJavaScriptアプリケーションの場合と同様に、好みのGraphQLクライアントライブラリを使用して、Sitecore GraphQLエンドポイントに対して直接HTTP要求を行うことができます。サンプルJSSアプリケーションでは、これはJSSアプリケーションではConnected GraphQLと呼ばれます。

もう1つのオプションは、JSSアプリで統合GraphQLを使用することですが、ここでは、クエリはレイアウトサービスエンドポイント内で実行され、クエリ結果はレイアウトサービスレスポンスで返されるJSONデータにマージされます。

メモ

このコンテキストでのconnectedとintegratedという用語は、アプリケーションモードと何らかの関係があるdo not。

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

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