GraphQL の意味論や、Cloudflare GraphQL API でできることを把握しづらいことがあります。
このページでは、GraphiQL クライアント ↗で GraphQL クエリを作成し、実行する手順を説明します。
クライアントの設定手順は、こちらを参照してください。
GraphiQL の編集ペインをクリックし、次の基本クエリを追加します。zone-id は自分の Cloudflare ゾーン ID に置き換えてください。
クエリ作成を助けるため、GraphiQL クライアントには単語補完があります。クエリ内にカーソルを置き(この例では zones の次の行)、値の入力を始めると機能します。たとえば firewall と入力すると、ファイアウォール情報を返すデータセットがポップアップメニューに表示されます。
リスト下部のテキストは、そのノードが返すデータの短い説明です。
クエリしたいデータセットを選んで挿入します。リストの項目をクリックするか、矢印キーでスクロールして Return キーを押します。
フィールドにマウスを重ねると、データセットを説明するツールチップが表示されます。この例では、firewallEventsAdaptive ノードに重ねると次の説明が出ます。
データセットの情報(必須パラメーターを含む)を表示するには、データセット名(青い文字)を選びます。Documentation Explorer が開き、データセットの詳細が表示されます。
filter と limit 引数は必須です。型定義(金色の文字)のあとの感嘆符(!)がそれを示します。この例では、orderBy 引数は必須ではありません。使う場合は、型 ZoneFirewallEventsAdaptiveOrderBy の値が必要です。
対応するフィルターフィールドの一覧を見るには、Documentation Explorer でフィルターの型定義(金色の文字)を選びます。この例では、型は ZoneFirewallEventsAdaptiveFilter_InputObject です。
次のクエリ例は、firewallEventsAdaptive(および他の GraphQL ノード)に必要な filter と limit 引数を示しています。
クエリで使えるフィールドを見るには、クエリ内のデータセット名にカーソルを重ね、表示されるツールチップでデータ型の定義(金色の文字)を選びます。
Documentation Explorer が開き、フィールドの一覧が表示されます。
読み取りたいデータフィールドを追加するには、パラメーターの閉じ括弧のあとに開き波括弧({)を入力し、取得したいフィールド名の入力を始めます。単語補完でフィールドを選べます。
次のクエリ例は、action、datetime、clientRequestHTTPHost、userAgent フィールドを返します。
クエリしたいフィールドをすべて入力したら、Play ボタンを選んでクエリを送信します。レスポンスペインに、設定した GraphQL API エンドポイントから取得したデータが表示されます。
GraphiQL クライアントでは、値のプレースホルダーを使い、ペイロードの variables 部分で渡せます。
プレースホルダー名は $ で始めてください。クエリ内ではプレースホルダーを引用符で囲む必要はありません。
プレースホルダーの値は JSON 形式で渡します。JSON では $ なしでプレースホルダーを指定します。たとえば、プレースホルダー $zoneTag の場合、GraphQL API は渡した変数オブジェクトの zoneTag フィールドから値を読みます。
プレースホルダーの値を渡すには、Query Variables ペインを選び、変数を定義する JSON オブジェクトを編集します。
次のクエリ例は、ゾーン ID を表すクエリ変数 zoneTag を使います。
