JSSサービスとAPI

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

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

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

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

JSSアプリケーションで最も頻繁に使われるサービスとAPIは、サービス・クライアント・フェッチャーの実装パターンに従い、RESTの要求/応答、GraphQLクエリ、またはその両方をサポートします。このパターンを使用するサービスとAPIは以下の通りです:

  • JSSレイアウトAPI - すべてのフレームワークで利用可能で、RESTおよびGraphQLエンドポイントに対応しています。
  • JSS Dictionary API - すべてのフレームワークで利用可能で、RESTおよびGraphQLエンドポイントに対応しています。
  • GraphQL Sitemap Service - Next.js専用。

地域の開発環境、選択した開発ワークフロー、フレームワークによっては、以下にも慣れる必要があるかもしれません:

用語

JSSサービスには以下の用語を使用しています。

工場

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

運用

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

  • 設定オブジェクトを受け入れます。
  • フェッチ方式が含まれています。
  • デフォルトの クライアント がデータ取得を担当しています。
  • データモデルを定義します。
  • 開発者入力のロジックを検証します。
  • デフォルトの Fetcherを実装します。

サービスをカスタマイズする

JSS 18.0.0以降、フロントエンドJSSサービスのカスタマイズ・拡張に推奨される方法は以下の通りです:

  1. サービス自体を延長しましょう。
  2. 新しいサービスはサービス工場で活用しましょう。
この記事を改善するための提案がある場合は、 お知らせください!