GraphQL 格式化工具
使用此 GraphQL 格式化工具格式化 GraphQL 查询、变更、片段和架构。粘贴文档后,工具会使用 GraphQL 解析器进行解析,并按标准布局输出:缩进两个空格,每行一个字段,移除字段间的逗号,并统一参数和变量的空格格式。工具会报告语法错误,让 API 开发者获得易读的操作和 SDL,用于编写文档、审查和调试。
常见问题
GraphQL 格式化工具如何工作?
它会将你的文档解析为 GraphQL 语法树,再按标准布局重新输出。由于文档会经过解析,无效的 GraphQL 会被拒绝,以免错误地重新格式化。
可以格式化哪些内容?
可以格式化查询、变更、订阅和片段,也可以格式化 SDL 中的架构定义,例如 type、input、enum、interface、union 和 schema 块。一个文档中可以包含多个定义。
输出是什么样的?
每个选择集都采用两个空格缩进,每行一个字段,并移除字段间的逗号。参数和变量定义中的冒号后会添加空格,例如 user(id: $id)。
遇到语法错误时会怎样?
工具会停止处理并显示解析器消息,例如 Syntax Error: Expected Name, found }。请修复指出的位置后重新格式化。
注释会保留吗?
格式化工具会在解析器能够关联的位置保留井号注释 (#),例如右花括号之后。架构类型和字段中用引号括起来的描述属于文档内容,始终会保留。
它会根据架构验证我的查询吗?
不会,它只检查语法。字段和参数是否存在由服务器的架构决定,因此请使用你的 GraphQL 客户端或服务器进行验证。
可以格式化从 JavaScript 复制的查询字符串吗?
请只粘贴 GraphQL 文档,不要包含外围引号、反引号或 gql 标签。来自 JSON 负载的转义字符应先取消转义。
可以更改缩进吗?
不能,格式化工具始终使用两个空格缩进,没有可选设置。这与大多数 GraphQL 工具和文档采用的布局一致。
为什么结果会被包在 graphql 代码围栏中?
输出会以标记为 graphql 的 Markdown 代码块形式返回,因此会在 Markdown 中以高亮形式呈现。请将围栏之间的内容复制到 .graphql 文件中。
我的文档最大可以有多大?
每次运行最多支持 5 MB;超过此大小的输入会被拒绝并显示提示。输出与 Code Formatter 的 GraphQL 选项完全一致。