このセクションの内容:

はじめに

メッセージ ツールとレスポンダーでは、[入力モード] メニューからメッセージの入力方法を指定できます (たとえば、リクエスト、レスポンス、ペイロード)。フォーム GraphQL 入力モードでは、GraphQL メッセージがツリー ビューで表示されるため、グラフィカルなインターフェイスで GraphQL メッセージを作成および確認できます。このモードは、GraphQL に特化した フォーム入力 モードです。

SDL に制約された GraphQL メッセージ

GraphQL メッセージを SDL にリンクすることで、GraphQL メッセージをスキーマ定義に制約することができます。SDL に制約された GraphQL メッセージを作成するには、次の操作を行います。

1. [SDL] フィールドに SDL の URL または場所を入力します。[参照] をクリックして SDL ファイルに移動することもできます。
2. [SDL に従う] を有効にします。
3. [入力モード] メニューから フォーム GraphQL を選択します。
   

SDL が更新された場合は、この画面に戻り、[SDL のリフレッシュ] をクリックして、GraphQL メッセージの制約を更新します。

SDL に制約されると、スキーマに従ってツリーを構築するときに使用できる要素が制限されます。それらを追加する方法は、そのタイプによって異なります。

クエリー、ミューテーション、サブスクリプション

最上位ノード ( {} ) を選択し、[クエリー]、[ミューテーション]、または [サブスクリプション] テーブルの [挿入] をクリックします。

フィールド

フィールドは、SDL の指定に従って、オペレーション、フラグメント、または他のフィールドに追加することができます。フィールドを追加するには、次の操作を行います。

1. 新しいフィールドを追加するオペレーション、フィールド、またはフラグメントの SelectionSet を選択します。
2. 追加するフィールドを有効にします。そうすることで、フィールドの新しいノードが作成されます。
3. このノードを選択し、編集します。

引数

引数は、フィールドまたはディレクティブに追加できます。SDL で指定されている必須の引数は、自動的に含まれます。オプションの引数は自動的には含まれません。オプションの引数を含めるには、次の操作を行います。

1. フィールドまたはディレクティブの下で目的の引数ノードを選択します。
2. 引数が null である可能性があることを SDL が示している場合、null オプションがあります。有効にすると、値は null になります。null 以外の値を引数に割り当てるには、これを無効にします。
3. 引数ノードを選択して編集します。

引数は変数に変換できます。これを行うには、目的の引数ノードを右クリックし、[Switch to Variable Reference] を選択します。

ディレクティブ

ディレクティブは、SDL で指定されているように、オペレーション、フラグメント、フィールド、または変数に追加できます。ディレクティブを含めるには:

1. 新しいディレクティブを追加するオペレーション、フラグメント、フィールド、または変数を選択します。
2. ディレクティブがまだ有効になっていない場合は有効にします。これにより、Directives ノードが作成されます。
3. Directives ノードを選択し、含めるディレクティブを有効にします。そうすることで、ディレクティブの新しいノードが作成されます。ディレクティブに追加の設定がある場合は、そのノードを選択して編集できます。

変数

オペレーションに変数を追加できます。変数を追加するには、次の操作を行います。

1. 新しい変数を追加するオペレーションを選択します。
2. [変数] テーブルの下の [挿入] をクリックします。そうすることで、新しい変数が作成されます。
3. 変数ノードを選択して編集します。

フィールド、引数、またはディレクティブを削除するには、その親ノードを選択してチェックを外します。変数を削除するには、[変数] テーブルで変数を選択し、[削除] をクリックします。

制約のない GraphQL メッセージ

制約のない GraphQL メッセージを手動で作成するか、使用可能な GraphQL メッセージがある場合は、それを使用して フォーム GraphQL を作成できます。そのためには、GraphQL メッセージをリテラル ビューに貼り付けてから フォーム GraphQL ビューに切り替えます。フォーム GraphQL ビューには、指定された値が自動的に取り込まれ、メッセージのグラフィカル表現が表示されます。

フォーム ビューから新しい GraphQL オペレーションを追加できます。最上位ノード ( {} ) を選択し、[クエリー]、[ミューテーション]、または [サブスクリプション] テーブルの [挿入] をクリックします。

GraphQL メッセージをリテラル ビューに貼り付けてフォーム GraphQL ビューに変換した場合でも、オペレーションを手動で追加した場合でも、フィールド、引数、ディレクティブ、および変数をフォーム ビューから追加および削除することができます。

フィールド

フィールドは、オペレーションまたは他のフィールドに追加できます。フィールドを追加するには、次の操作を行います。

1. 新しいフィールドを追加するオペレーションまたはフィールドを選択します。
2. まだ有効になっていない場合は、SelectionSet を有効にします。これにより、SelectionSet ノードが作成されます。すでに有効になっている場合は、次の手順に進みます。
3. SelectionSet ノードを右クリックし、[挿入] を選択します。
4. 新しいフィールドの名前を入力し、[OK] をクリックします。

引数

引数は、フィールドまたはディレクティブに追加できます。フィールドに引数を追加するには、次の操作を行います。

1. 新しい引数を追加するオペレーションを選択します。
2. 引数がまだ有効になっていない場合は有効にします。これにより、Arguments ノードが作成されます。すでに有効になっている場合は、次の手順に進みます。
3. Arguments ノードを右クリックし、[挿入] を選択します。
4. 新しい引数の名前を入力し、[OK] をクリックします。

ディレクティブに引数を追加するには、次の操作を行います。

1. 新しい引数を追加するディレクティブを右クリックし、[挿入] を選択します。
2. 表示されたダイアログに引数の名前を入力し、[OK] をクリックします。

ディレクティブ

ディレクティブは、オペレーション、フィールド、または変数に追加することができます。ディレクティブを追加するには、次の操作を行います。

1. 新しいディレクティブを追加するオペレーション、フィールド、または変数を選択します。
2. ディレクティブがまだ有効になっていない場合は有効にします。これにより、Directives ノードが作成されます。すでに有効になっている場合は、次の手順に進みます。
3. Directives ノードを右クリックし、[挿入] を選択します。
4. 新しいディレクティブの名前を入力し、[OK] をクリックします。

変数

オペレーションに変数を追加できます。変数を追加するには、次の操作を行います。

1. 新しい変数を追加するオペレーションを選択します。
2. [変数] テーブルの下の [挿入] をクリックします。そうすることで、新しい変数が作成されます。
3. 変数のノードを選択し、その名前とタイプを入力します。

フィールド、引数、またはディレクティブを削除するには、ノードを右クリックして [削除] を選択します。変数を削除するには、[変数] テーブルで変数を選択し、[削除] をクリックします。

値の編集

各種のツリー ビューでは、固定、パラメータライズ、自動、およびスクリプト オプションを使用して値を指定できます。

GraphQL に適用可能なフォーム入力ビュー オプションは、このビューにあります (nil が null に変更されるなど、適宜用語が変更されます)。データ ソースの値をツリー全体に流し込む、CSV データ ソース テンプレートを作成する、特定の要素をデータ ソース値に置換するなどのオプションがあります。詳細については、「フォーム入力」を参照してください。

リテラル GraphQL の表示

リテラル ビューに切り替えると、フォーム GraphQL ビューの内容がリテラル ビューに適用されます。リテラル ビューで GraphQL メッセージを右クリックすると、 自動的に GraphQL を [整形して表示] することができます。