GraphQL エクスプローラーで GraphQL API をテストする

統合された GraphQL テストツールを使用して、GraphQL API のクエリをテストします。

始める前に

GraphQL API のスキーマを作成します。詳細については、「GraphQL スキーマの作成」を参照してください。

イントロスペクションクエリを有効にすると、GraphQL エクスプローラーはインスタンスのスキーマをドキュメントエクスプローラーに表示し、オートコンプリート提案として表示できるため、クエリとミューテーションを簡単に見つけることができます。詳細については、「GraphQL スキーマのイントロスペクションクエリを有効にする」を参照してください。

注:

本番環境ではイントロスペクションクエリを使用しないでください。

必要なロール:graphql_schema_admin または admin

このタスクについて

GraphQL エクスプローラーは、GraphiQL IDE を ServiceNow AI Platformに統合します。インターフェイスの詳細については、GraphiQL GitHubリポジトリの GraphiQL readme を参照してください。

手順

1. 移動先 すべて > システム Web サービス > GraphQL > GraphQL エクスプローラー.
2. オプション: イントロスペクションを有効にした場合は、左側のサイドバーで [ドキュメントエクスプローラーを表示] アイコン ( [ ) を選択して、使用可能なクエリまたはミューテーションを表示および検索します。
3. エディターで、スキーマに対するクエリーを入力します。

   クエリにアプリケーションとスキーマの両方の名前空間を含めます。適用できるディレクティブの詳細については、「 ディレクティブとグローバル関数」を参照してください。

   次の例は、アプリケーションとスキーマの両方の名前空間の使用を示しています。

   • アプリケーション名前空間: x_graph_scope
   • スキーマ名前空間: 惑星

   query {
     x_graph_scope {
       planet {
         findAll {
           name
           mass
           distance
         }
       }
     }
   }

   この例では、最初のインシデント応答後に @defer ディレクティブを使用して openedBy フィールドの結果をストリーミングする方法を示しています。

   query findIncidents {
     now {
       incident {
         findAll {
           description {
             displayValue
           }
           ...
           @defer(label: "my-label", if: true) {
             openedBy {
               firstName
               lastName
             }
           }
         }
       }
     }
   }

4. オプション: エディターの下部で [変数] を選択し、必要な変数を入力します。
5. [クエリを実行] アイコン ( ) を選択します。
   ヒント:

   キーボードショートカットを使用することもできます。使用可能なキーボードショートカットのリストを表示するには、[ショートキーダイアログを開く] アイコン ( ) を選択します。
   クエリの結果が右側のペインに戻ります。
6. オプション: [タブの追加] アイコン (タブ ) を選択して、追加のクエリを実行します。

次のタスク

以前のクエリのリストを表示する必要がある場合は、左側のサイドバーで [履歴を表示] アイコン ( ) を選択します。

コンポーネント内のレコードデータにアクセスするには、カスタムコンポーネントを作成し、コンポーネントからスクリプト化された GraphQL スキーマをクエリします。詳細については、「コンポーネントからの GraphQL スキーマのクエリ」を参照してください。