はじめに
このツールは、スキーマ定義言語 (SDL) を使用して定義されたスキーマに対して GraphQL クエリーを検証し、呼び出し元が現在のスキーマに合わせて GraphQL クエリーと GraphQL レスポンダーを更新する必要があることを認識できるようにします。GraphQL Query Validator をスタンドアロン ツールとして使用して、GraphQL クエリーを手動で検証するか、あるいは GraphQL 形式でメッセージを送受信するツールに接続して、ペイロードが有効であることを確認できます。
一般的なワークフローでこのようなバリデータを使用する例については、「受信リクエストの検証」を参照してください。
既存ツールへの GraphQL Query Validator の連結
GraphQL Query Validator ツールは、 GraphQL 形式でデータを交換するテスト クライアント、PVA レスポンダー、またはその他のツールに連結できます。
- ツールを右クリックし、[出力の追加...] をクリックします。
検証するトラフィック オプションを選択して GraphQL Query Validator を選択し、[完了] をクリックします。
- [GraphQL SDL location] フィールドに SDL の URL または場所を入力します。[参照] をクリックして SDL ファイルに移動することもできます。
- スイートで定義されている場合は、
${variable-name}構文を使用して環境変数を参照することもできます。変数を参照すると、解決された URL が表示されます。
- スイートで定義されている場合は、
- XML ファイルへのパスを現在のコンフィギュレーション ファイルからの相対パスとして保存する場合、 [相対パスで保存] を有効にします。
クライアントの実行時に、クエリーが SDL に準拠していない場合はエラーが報告されます。
スタンドアロン GraphQL Query Validator の使用
- テスト スイートを右クリックし、[新規追加] > [テスト] をクリックします。
- 検証するテストの種類を選択し、GraphQL Query Validator を選択して [完了] をクリックします。
- [GraphQL SDL location] フィールドに SDL の URL または場所を入力します。[参照] をクリックして SDL ファイルに移動することもできます。
- スイートで定義されている場合は、
${variable-name}構文を使用して環境変数を参照することもできます。変数を参照すると、解決された URL が表示されます。
- スイートで定義されている場合は、
- XML ファイルへのパスを現在のコンフィギュレーション ファイルからの相対パスとして保存する場合、 [相対パスで保存] を有効にします。
- [入力] タブをクリックし、[テキスト] または [ファイル] オプションを選択して、受信ペイロードを指定します。
- 変更を保存します。
クライアントの実行時に、クエリーが SDL に準拠していない場合はエラーが報告されます。