GraphQL スキーマエクスプローラー

スキーマを読み込み、操作を貼り付けると、公開されているルートフィールド、選択の有無、編集可能な変数テンプレートを確認できます。すべてブラウザ内で実行され、部分的なチェックは完全な GraphQL 検証の代わりにはなりません。

ブラウザ内でローカルに実行
解析と分析はすべてこのブラウザ内で行われます。データのアップロードや API への送信はありません。
スキーマまたはイントロスペクション JSON
検証する操作

これはスキーマとクエリの支援ツールです。操作、変数、スキーマを GraphQL エンドポイントに送信することはありません。

スキーマの概要
  • スキーマを貼り付けて、型、ルートフィールド、ローカル操作を検査します。
変数テンプレート
型とルートフィールド
  • スキーマを貼り付けて、型、ルートフィールド、ローカル操作を検査します。

API クライアントを使用する前に GraphQL 構造を検証します

エクスプローラーは一般的な SDL およびイントロスペクション構造を識別し、ルートフィールドを確認して、初期変数オブジェクトを作成します。サーバー側の GraphQL 検証の代わりにはなりません。

「GraphQL スキーマエクスプローラー」の使い方

SDL 形式またはイントロスペクション JSON の GraphQL スキーマを読み取り、見つかったすべての型とスキーマが定義するルート型を一覧表示します。

スキーマの下に操作を貼り付けると、ルートの選択が対応するルート型に存在するかを確認し、変数テンプレートを作成できます。解析はブラウザ内で実行され、エンドポイントには何も送信されません。

  1. 左の欄に SDL またはイントロスペクション JSON を貼り付けるか、.graphql・.json・.txt ファイルを読み込みます。
  2. 右の欄に検証するクエリ、ミューテーション、またはサブスクリプションを貼り付けます。
  3. 「スキーマとクエリを検査」を押すと、型とルートフィールドの数が集計され、各ルート選択が存在するかどうかが表示されます。
  4. 変数テンプレートをコピーし、実際の値を入れてから API クライアントで操作を実行します。

背景と精度

検査がカバーする範囲

スキーマは説明・コメント・ディレクティブ・デフォルト値を理解するトークナイザーで読み取るため、デフォルト値や説明の中の波括弧があっても型とフィールドは失われず、enum の値がディレクティブと混ざることもありません。

貼り付けた操作からは最初のクエリ・ミューテーション・サブスクリプションを取り出し、フラグメント定義は読み飛ばします。エイリアスを含む最上位の選択が、対応するルート型のフィールドと照合されます。

ルート型と選択

スキーマは schema { ... } ブロックか、既定名 Query・Mutation・Subscription でルートを定義します。ブロックが優先されるため、Query という名前の型はブロックが query に対応付けたときだけルートになります。

フラグメントスプレッドとインラインフラグメントはフィールドとして数えません。クエリはクエリルート、ミューテーションは Mutation、サブスクリプションは Subscription に対して検査され、ルート型がなければ誤ったフィールドを報告する代わりにその旨を表示します。

変数テンプレート

操作で定義された各変数には例の値が入ります。String と ID は「example」、Int と Float は 0、Boolean は false、enum は最初の値を使い、入力オブジェクトは自身のフィールドで展開されます。

リスト型は配列になります([ID!]! は ["example"])。深くネストした入力は 3 階層で「example」に戻ります。テンプレートは出発点であり、アップロードも実行もされません。

最近使ったツール: