GraphQL IDE
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
このGraphQL Integrated Development Environment (IDE)は、Graph QLクエリ機能をサポートし、クエリの開発を容易にすることで開発ワークフローを改善します。リアルタイムの構文とエラーの強調表示、およびスキーマ ドキュメントのスニペットを使用すると、クエリに何を追加しているかがわかります。
IDEを使用するには、有効なAPIキー が必要です。
GraphQL IDEは、次の場合に利用できます。
-
プレビュー APIを使用すると、下書きやまだ承認されていないその他のコンテンツなど、すべてのコンテンツにアクセスできます。
-
DeliveryのAPI IDEは、Preview API IDEと同じスキーマを持ちますが、承認済みおよび公開済みのコンテンツへのアクセスのみを提供します。
GraphQL IDEの特徴
Sitecore GraphQL IDEはGraphQL Playgroundを使用しており、以下の機能を提供しています。
|
特徴 |
形容 |
|---|---|
|
クエリ履歴 |
GraphQL IDEはクエリの履歴を保持します。 |
|
ブックマーク |
頻繁に使用するクエリをブックマークして、履歴の一番上に保持し、星のアイコンでマークできます。 |
|
Prettify |
Prettifyは、正しいインデントを追加することでクエリを書式設定します。 |
|
オートコンプリート |
オートコンプリート機能を使用すると、必要なフィールドを直感的に見つけることができます。構文の強調表示、リンティング、オートコンプリート、フラグメントへのナビゲーションを提供します。 |
|
「スキーマ」タブ |
「 SCHEMA 」タブでは、定義された スキーマにアクセスできます。 |
|
DOCS タブ |
DOCSタブには、GraphQLに使用できるドキュメントが表示されます。インタラクティブで、複数の列で表示でき、ネイティブキーボードをサポートしています。 DOCSタブを使用すると、クエリで想定されるパラメーターと、応答に指定できるフィールドに関するすべての情報を確認できます。 |
|
変数 |
新しいクエリを再構築する代わりに、引数として値を渡すことができます。クエリ変数は、IDEのQUERY VARIABLESタブで追加できます。 |
GraphQL IDEの「 DOCS 」タブを使用して、次の操作を実行できます。
|
アクション |
形容 |
|---|---|
|
特定のスキーマフィールドを検索します。 |
フィールドを名前 ( assetなど) で検索します。このインターフェースは、同じ名前のフィールドを区別するのに役立ちます。検索はfuzzyであり、正確なスペルが不明な場合は、おおよそのスペルに基づいてフィールドを返すことができます。 |
|
スキーマのエントリ ポイントからフィールドへの理想的なパスを見つけます。 |
タイプとフィールドのペアを識別した後、エクスプローラーは、スキーマのエントリポイントから始めて、そのフィールドへのすべてのパスをリストできます。パスは深さの順にリストされています。 |