多くの GraphQL クライアントは、イントロスペクション を使って GraphQL スキーマの閲覧に対応しています。このページでは GraphiQL と Altair を扱います。
GraphiQL ↗ と Altair ↗ はオープンソースの GraphQL クライアントで、クエリの作成、実行、結果の確認ができます。さらに、GraphQL スキーマの閲覧もできます。
始める前に、API エンドポイントと HTTP ヘッダーを 設定 してください。
以降のスクリーンショットは GraphiQL です。ただし Altair も同じ機能を提供するため、同じ手順でスキーマを探索できます。
GraphiQL の Documentation Explorer を開くには、レスポンスペインのヘッダーにある Docs リンクを選びます。
Documentation Explorer が開き、利用可能なオブジェクトの一覧が表示されます。
Documentation Explorer のオブジェクトは、次の構文です。
object-name: object-type-definitionDocumentation Explorer ペインを最初に開くと、mutation と query のルート型が表示されます。
この例では、query がルートの名前、Query が型定義です。
ノードの type definition をクリックすると、そのノードが提供するフィールドを確認できます。Documentation Explorer には、ノードの説明も表示されます。
たとえば Query の型定義を選びます。Documentation Explorer は、Query が提供するフィールドを表示します。この例のフィールドは cost と viewer です。
スキーマを探索するには、オブジェクト名と定義名を選びます。検索入力（虫眼鏡アイコン）と、ヘッダーのパンくずリンクも使えます。
viewer フィールドの型定義（金色のテキスト）をクリックすると、サブフィールドが一覧されます。viewer フィールドは、accounts または zones のデータをクエリするサブフィールドを提供します。
accounts と zones ノードは、クエリするデータセットを指定する引数を取ります。
たとえば zones は、ZoneFilter_InputObject 型のフィルターを引数として取れます。フィルターに使えるフィールドを確認するには、ZoneFilter_InputObject を選びます。
クエリできるデータセットの一覧を見るには、zone の型定義（金色のテキスト）を選びます。
Fields セクションにデータセットの一覧が表示され、それぞれ有効な引数と短い説明があります。末尾が感嘆符（!）の引数は必須です。
特定のデータセットを探すには、検索入力（虫眼鏡アイコン）を使います。
データセットを選ぶには、その名前を選びます。
データセットの定義が表示されます。この例は firewallEventsAdaptive データセットです。
特定のデータセットで使えるフィールドを見るには、その型定義（金色のテキスト）を選びます。
たとえば ZoneFirewallEventsAdaptive の型定義を選ぶと、firewallEventsAdaptive データセットで使えるフィールドを確認できます。
フィールドの一覧が表示されます。
GraphiQL の使い方の詳細は、この ガイド を参照してください。