「テスト」タブを使用した GraphQL API のテスト

オンラインで編集する

GraphQL API 定義の場合、「テスト」タブに GraphiQL エディターが含まれます。 GraphiQL エディターを使用して、GraphQL 照会を作成できます。 GraphQL API をテストすると、GraphiQL エディターに応答が表示されます。

以下のいずれかの方法で GraphQL 照会をテストできます。

POST 操作を使用します。この場合、照会は操作要求の本文で送信されます。
GET 操作を使用します。この場合、照会は照会パラメーターとして送信されます。

操作タイプごとに、照会を GraphQL API エンドポイント自体に対してテストすることも、要求のコストの詳細を GraphQL API エンドポイントに返すコスト・エンドポイントに対してテストすることもできます。

どちらの方法およびエンドポイントを使用する場合でも、照会を直接指定することも、GraphiQL エディターを使用して照会を作成することもできます。エディターは、API に対して定義されたスキーマに基づいて先行入力機能を提供するほか、エラーを強調表示して修正の提案を示します。このスキーマは、 GraphQL APIの定義が作成された際に最初にアップロードされましたが、その後変更されている可能性があります。 GraphQL のAPI定義の作成方法の詳細については、「 GraphQL プロキシAPIの作成」を参照してください。スキーマの変更方法の詳細については、「 GraphQL スキーマエディタの使用」を参照してください。

開始前に

「テスト」タブを使用してAPIをテストするために、API定義が満たすべき要件については、「テスト」タブを使用したデバッグのためのAPIの準備」を参照してください。

手順

「要求」セクションで、目的の操作タイプとエンドポイントを選択します。例えば、以下のようにします。
- POST https://myserver.com/myorg/sandbox/mybasepath/graphql
- GET https://myserver.com/myorg/sandbox/mybasepath/graphql/cost
エディタの左ペインにある「 GraphiQL 」タブで、クエリを入力します。例：
```
{
  accounts(limit: 100) {
    name {
      first
      last
    }
  }
}
```
必要に応じて、「パラメータ」タブでさらにリクエストヘッダーを追加できます。
照会に変数が含まれている場合は、「Query Variables」ペインで変数の値を指定できます。例えば、以下のような照会であるとします。
```
query MyQuery($Query__accounts__limit: Int)
{
  accounts(limit: $Query__accounts__limit) {
    name {
      first
      last
    }
  }
}
```
「クエリー変数」ペインに以下を入力して、 Query__accounts__limit の値を設定できます。
```
{
  "Query__accounts__limit": variable_value
}
```
ここで、variable_value は必須値です。
エディタ内の「送信」または「クエリの実行」アイコンをクリックしてください。 GraphiQL エディターに応答が表示され、「トレース」セクションに API 呼び出しがどのように実行されたかが示されます。トレース情報について詳しくは、トレースの検査を参照してください。