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> 打印器（printer）重新格式化代码。
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 Formatter（GraphQL 格式化工具）使用官方 graphql/language 解析器，对 GraphQL 的 query、mutation 以及 schema definition language（SDL）进行美化排版。工具会先解析输入内容，再以统一的缩进和空白重新生成代码，让 GraphQL 文档在浏览器中即可变得结构清晰、易于阅读。

功能特性

示例

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

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

常见使用场景

1. 1

   整理复制的查询

   将单行或混乱的 GraphQL 查询重新格式化为易读的缩进形式。

2. 2

   清理 SDL

   在提交或审查之前，规范化模式文件的间距。

3. 3

   边格式化边验证

   解析错误会在您发送查询之前准确指出语法错误。

参考资料

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

相关工具