GraphQL 格式化工具

用 Prettier 格式化 GraphQL 查询、变更、片段和 SDL schema,并保留注释。语法错误会显示行号和列号。免费,在浏览器中运行。

输出

完全在浏览器中运行,您的数据不会被上传。

相关工具

查看全部

什么是 GraphQL 格式化?

GraphQL 格式化工具会以统一的缩进美化 GraphQL 操作(查询、变更、订阅、片段)和 schema 定义语言(SDL)。注释会被保留。

如何使用 GraphQL 格式化

  1. 粘贴 GraphQL 查询或 schema。
  2. 选择 缩进。
  3. 点击 格式化(输入时输出也会更新)。
  4. 复制或下载格式化后的 GraphQL。

示例

输入
query { user(id: 1) { name } }
输出
query {
  user(id: 1) {
    name
  }
}

何时使用 GraphQL 格式化

适合阅读从网络请求中捕获的压缩查询、为文档格式化操作,或检查查询语法。它不会按你的 schema 验证字段。

GraphQL 格式化 的工作原理

文档使用 Prettier 的 GraphQL 插件格式化:它通过参考实现 graphql-js 的解析器解析,并把每个选择集放在各自缩进的行上,规范参数和变量的间距,较长的参数列表会换行。由于 Prettier 会保留注释(与 graphql.print 不同),# 注释 也能保留下来。解析错误会连同行号和列号一起报告。

常见用例

  • 阅读从浏览器开发者工具复制的单行查询
  • 在审查前格式化 schema 文件
  • 为文档准备 GraphQL 示例
  • 快速检查查询语法

安全提示

所有处理都在你的浏览器本地完成,粘贴的代码不会被上传。

常见问题

会按我的 schema 验证吗?

不会,只检查 GraphQL 语法。

注释会保留吗?

会。

能格式化 SDL 类型定义吗?

能,支持包含 type、input、enum 和 directive 定义的 schema。

探索更多分类