GraphQL フォーマッター
GraphQL のクエリ、ミューテーション、フラグメント、SDL スキーマを、コメントを保ったまま Prettier で整形。構文エラーは行と列付きで表示。無料でブラウザ内で動作。
すべてブラウザ内で実行されます。データがアップロードされることはありません。
関連ツール
すべて表示GraphQL フォーマッターとは?
GraphQL フォーマッターは、GraphQL の操作(クエリ、ミューテーション、サブスクリプション、フラグメント)とスキーマ定義言語(SDL)を、統一されたインデントで整形します。コメントは保持されます。
GraphQL フォーマッターの使い方
- GraphQL のクエリまたはスキーマを貼り付けます。
- インデント を選びます。
- 整形 をクリックします(入力中も出力は更新されます)。
- 整形された GraphQL をコピーまたはダウンロードします。
例
query { user(id: 1) { name } } query {
user(id: 1) {
name
}
} GraphQL フォーマッターを使うべき場面
ネットワークリクエストから取得した圧縮されたクエリの読み取り、ドキュメント用の操作の整形、クエリの構文チェックに使います。スキーマに対するフィールドの検証は行いません。
GraphQL フォーマッターの仕組み
文書は Prettier の GraphQL プラグインで整形されます。これはリファレンス実装の graphql-js パーサーで解析し、各セレクションセットをインデントした独自の行に、引数と変数をスペースを正規化して出力し、長い引数リストは折り返します。Prettier は(graphql.print と違って)コメントを保持するため、# コメント は残ります。解析エラーは行と列付きで報告されます。
一般的な使用例
- ブラウザの開発者ツールからコピーした 1 行のクエリを読む
- レビューの前にスキーマファイルを整形する
- ドキュメント用に GraphQL の例を準備する
- クエリの構文をすばやく確認する
セキュリティ注意事項
すべてブラウザ内でローカルに処理され、貼り付けたコードがアップロードされることはありません。
よくある質問
自分のスキーマに対して検証しますか?
いいえ、GraphQL の構文だけです。
コメントは保持されますか?
はい。
SDL の型定義も整形できますか?
はい、type、input、enum、directive の定義を含むスキーマに対応しています。