GraphQLフォーマッター

使い方

1. 1 GraphQLのquery、mutation、subscription、またはSDLを貼り付けます。
2. 2 「整形」を押すと、公式の<code class="rounded bg-slate-100 px-1 text-xs dark:bg-slate-800">graphql/language</code>プリンターで再フォーマットされます。
3. 3 「圧縮」は空白やコメントを取り除き、より軽量な形に変換します。
4. 4 構文エラーがある場合は、行番号と列番号とともに表示されます。

このツールを使う理由

• <code class="rounded bg-slate-100 px-1 text-xs dark:bg-slate-800">graphql/language</code>公式のparse/print関数を使用しているため、出力は標準（canonical）なSDLになります。
• パーサーは必要になったときだけ読み込まれる仕組みなので、初回入力までは余計な読み込みが発生しません。
• 整形（リポジトリ保存向け）と圧縮（転送向け）の両方向に対応しています。
• 処理はすべてクライアント側で完結し、queryがブラウザの外に送信されることはありません。

よくある質問

GraphQLフォーマッター とは？

GraphQLフォーマッター（GraphQL Formatter）は、公式のgraphql/languageパーサーを使ってGraphQLのquery・mutation・スキーマ定義言語（SDL）をきれいに整形するツールです。入力をパースしたうえで一定のインデントと空白ルールで再構築し、読みやすく構造の整ったGraphQLドキュメントをブラウザ上だけで生成します。

機能

例

{ user(id:1){name posts{title}} }

{
  user(id: 1) {
    name
    posts {
      title
    }
  }
}

主な用途

1. 1

   コピーしたクエリを整える

   1行にまとまった、または乱雑な GraphQL クエリを、読みやすいインデント付きの形式に再整形します。

2. 2

   SDL を整理する

   コミットやレビューの前に、スキーマファイルの間隔を正規化します。

3. 3

   整形しながら検証する

   パースエラーにより、クエリを送信する前に構文ミスの箇所を特定できます。

参考文献

• GraphQL Specification — GraphQL Foundation
• graphql-js — reference implementation — GitHub

関連ツール