GraphQL 格式化工具
格式化或压缩 GraphQL 查询和模式，验证语法并提取操作。
你的 GraphQL 查询、模式和变量在浏览器中本地处理，不会上传到任何服务器。
需要整理一个请求体？试试 JSON 格式化工具。
关于 GraphQL 格式化工具
这款 GraphQL 格式化工具会美化排版和压缩 GraphQL 查询、变更和 SDL 模式，同时检查每个文档是否能干净地解析。粘贴一个原始查询，GraphQL 美化工具会一致地缩进字段、参数和选择集；切换到压缩可将空白、逗号和注释剥离到最小的等效文档。它还会提取命名操作并美化排版附带的变量 JSON 对象，让你在一个地方整理完整请求，并将其当作快捷的 GraphQL 校验工具。它专为需要在分享前格式化 GraphQL 查询或美化 GraphQL 模式的前端与后端开发者、QA 工程师，以及任何调试 API 调用的人打造。所有处理都在你的浏览器本地完成，因此你的数据不会离开你的设备，也不会上传到任何服务器。
功能特性
- 用整洁、一致的缩进格式化查询、变更和 SDL 模式
- 通过移除空白、逗号和注释压缩文档
- 校验语法，使格式有误的查询显示清晰的解析错误
- 从粘贴的文档中提取并列出命名操作
- 在查询旁美化排版附带的变量 JSON 对象
- 一键在格式化和压缩模式之间切换
- 即时复制格式化或压缩后的输出
如何使用 GraphQL 格式化工具
- 将你的 GraphQL 查询、变更或模式粘贴到输入框。
- 选择格式化以美化，或压缩以压缩文档。
- 可选地粘贴一个变量 JSON 对象以美化排版它。
- 查看提取出的操作名称和任何语法错误。
- 从输出面板复制格式化或压缩后的结果。
示例
输入
query Hero($ep:Episode){hero(episode:$ep){name friends{name}}}
输出
query Hero($ep: Episode) {
hero(episode: $ep) {
name
friends {
name
}
}
}
格式化模式将一个紧凑的查询美化为缩进的 GraphQL。
常见错误与故障排除
- 粘贴后输出显示语法错误。 — 文档必须是有效的 GraphQL。检查是否有不匹配的花括号、缺失的字段选择或杂散的逗号，然后重新格式化。
- 操作名称面板提示没有命名操作。 — 匿名查询和 SDL 模式没有操作名称。如果你需要它被列出，请添加一个名称，例如 query GetUser { ... }。
- 变量框报告无效 JSON。 — 变量字段期望一个 JSON 对象，例如 { "id": "1000" }，而非 GraphQL 语法。请使用双引号键和有效的 JSON。
- 期望针对我的 API 进行模式校验。 — 本工具仅校验语法。它确认文档能解析，但不会针对特定模式检查字段。
常见问题
- 什么是 GraphQL 格式化工具？
- GraphQL 格式化工具会美化、压缩并语法检查 GraphQL 查询、变更和 SDL 模式，并提取命名操作——全部在你的浏览器中完成。
- 如何用本工具格式化 GraphQL 查询？
- 将你的查询、变更或模式粘贴到输入框并选择格式化。GraphQL 格式化工具会重新缩进字段、参数和选择集，让你复制整洁的结果。
- GraphQL 格式化工具会针对我的模式进行校验吗？
- 它校验语法，确认查询或模式能解析。它不会针对特定的模式定义检查操作。
- 压缩选项有什么作用？
- 压缩会移除空白、逗号和注释等可忽略字符，生成最小的等效 GraphQL 文档。
- GraphQL 格式化工具也能美化排版我的变量吗？
- 可以。将一个变量 JSON 对象粘贴到专用框中，它会在你的查询旁被格式化。
- 我的 GraphQL 查询会被上传到任何地方吗？
- 不会。GraphQL 格式化工具在你的浏览器中本地处理一切，因此你的查询、模式和变量不会离开你的设备。
相关工具
全部 ArrayKit 工具