GraphQL 格式化

使用方法

关于此工具

格式化 GraphQL 查询和变量并检查语法。可搜索 graphql formatter、graphql 整形。

使用方法

输入 GraphQL 查询和变量（JSON）或从文件加载。查看并复制格式化结果。语法错误时显示位置。

使用场景

• 提高 GraphQL 查询可读性 • 调试语法错误 • 格式化变量（JSON） • API 开发时的查询验证

How it works

■ 什么是 GraphQL？ GraphQL 是一种用于 API 的查询和模式语言。客户端可以只请求所需的数据，避免 REST 的过量获取。支持查询、变更和订阅；变量用于传递参数。

常见问题

Q: 此工具支持 GraphQL 变量（variables）吗？

A: 支持。在查询字段粘贴查询，在变量字段粘贴 JSON 变量。两者独立格式化，各自的语法错误会分别报告。

Q: 支持哪些类型的 GraphQL 文档？

A: 支持查询（query）、变更（mutation）、订阅（subscription）、片段（fragment）和 Schema 定义（SDL）。

Q: 可以用它在发送到 API 前验证查询吗？

A: 可以检查 GraphQL 语法（缺少大括号、无效关键字等），但不会针对特定 Schema 进行验证，字段名称错误不会被检测到。

Q: 为什么格式化结果与我的 IDE 不同？

A: 不同的格式化工具可能有不同的风格选择（例如字段之间的空行）。本工具遵循 graphql-js 参考库使用的标准 GraphQL 格式化惯例。

Q: 查询会发送到服务器吗？

A: 不会。所有格式化和语法检查均在浏览器内完成，查询和变量不会发送到任何服务器。