GraphQL Explorer で GraphQL API をテストする

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

始める前に

GraphQL スキーマの作成に展開したカスタムモバイルアプリケーションを使用して管理しました。

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

注:

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

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

このタスクについて

GraphQL Explorer は GraphiQL IDE を Now Platform. インターフェイスの詳細については、GraphiQL リポジトリの GraphiQLGitHub の readme を参照してください。

手順

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

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

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

   • アプリケーション名前空間：x_graph_scope
   • スキーマ名前空間：planet

   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 スキーマのクエリ」を参照してください。