JSSサービスとAPI

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

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

このトピックでは、Sitecoreヘッドレス サービス (旧称JSSサーバー コンポーネント) とSitecore JavaScriptレンダリングSDK (JSS) で利用可能なサービスとAPIについて説明します。

このトピックのサービスとAPIは、特に明記されていない限り、すべてのフレームワーク固有のレンダリングSDKで使用できます。

JSSアプリケーションで最も頻繁に使用されるサービスとAPIは、実装のservice-client-fetcherパターンに従い、REST要求/応答、GraphQLクエリ、またはその両方をサポートします。このパターンを使用するサービスとAPIは次のとおりです。

  • JSS Layout API - RESTエンドポイントとGraphQLエンドポイントを持つすべてのフレームワークで使用できます。

  • JSS Dictionary API - RESTエンドポイントとGraphQLエンドポイントを持つすべてのフレームワークで使用できます。

  • GraphQL Sitemap Service - Next.jsのみご利用いただけます。

ローカル開発のセットアップ、選択した開発ワークフロー、およびフレームワークによっては、次の点にも精通する必要があるかもしれません。

用語

JSSサービスでは、以下の用語を使用します。

工場

ファクトリは、serviceのインスタンスを作成します。 Next.jsサンプルアプリケーションには、GraphQLとRESTの両方をサポートするサービスのファクトリの例があります。

サービス

サービスは、Sitecoreデータの取得を容易にするJavaScriptの抽象化 (クラス) です。サービス:

  • 設定オブジェクトを受け入れます。

  • fetchメソッドが含まれています。

  • データのフェッチを実行するデフォルトのclientがあります。

  • データモデルを定義します。

  • (開発者入力) ロジックを検証します。

  • デフォルトのFetcher.

サービスのカスタマイズ

JSS 18.0.0以降、フロントエンドJSSサービスをカスタマイズ/拡張するための推奨される方法は次のとおりです。

  1. サービス自体を拡張します。

  2. 新しいサービスをサービスファクトリで使用します。

この記事を改善するための提案がある場合は、 お知らせください!