JSON到GraphQL类型定义生成器

JSON到GraphQL类型定义生成器

粘贴任何 JSON 对象或数组，即可立即获得一个描述其结构的 GraphQL 方案定义语言（SDL）文档。该生成器遍历 JSON 树，推断标量类型，为嵌套对象命名，合并数组对象变体，并生成可选的根类型，使输出可以直接用于 Apollo、Yoga、Mercurius 或 graphql-go 服务器。 Query 类型

为什么确定性的 JSON 到 GraphQL SDL 转换器很重要

从样本数据手动编写 GraphQL 类型是机械性的，但容易出错。一个遗漏的可空性、不一致 Int vs Float，或在列表元素上忘记添加非空标记，都可能导致所有下游客户端的代码生成失败。一个基于规则的生成器每次处理相同的 JSON 样本都会得到一致的结果，因此在每次 API 更新时安全地重新生成是可行的。

如何使用

1. 将 JSON 对象或数组粘贴到输入框中，或点击 尝试一个示例 以加载一个代表性数据。
2. 设置 根类型名称 如果您希望使用除 Root.
3. 选择一个 字段空值性 策略之外的其他策略——严格（!）用于必需字段或所有可空用于原型设计。
4. 切换 ID 检测 将自动提升 id 且 *Id 键到 GraphQL ID 标量。
5. 可选地包含一个根 Query 类型，带有单实体和列表实体字段。
6. 复制 SDL 或将其下载为 schema.graphql.

特征

• 标量推断 – 确定性地区分 String, Int, Float, Boolean，并且 ID 。
• 嵌套对象类型 – 为每个嵌套对象生成一个独立的命名类型，使用字段键的 PascalCase。
• 对象数组合并 – 将数组中每个项目的字段进行合并，因此可选字段被正确标记。
• 可空与非空切换 – 发出严格的 ! 标记或放宽所有内容为可空，以用于早期原型。
• 自动 ID 检测 – 将 id, userId, orderId 风格的键升级为 ID 标量。
• 根查询骨架 – 可选的 type Query { ... } 带有单实体和列表实体解析器签名。
• 客户端仅支持 – 您的 JSON 从未离开浏览器，因此该工具适用于敏感数据。

类型推断规则

• 整数映射到 Int；带有小数部分的数字映射到 Float。一个字段被同时看到时，会提升到 Float.
• 字符串映射到 String。当启用 ID 检测时，键名为 id 或以 Id 结尾的键变为 ID.
• 布尔值映射到 Boolean.
• null ，值标记字段为可空，因此生成的 SDL 会跳过尾随 !.
• 空数组默认为 [String] ，因为无法安全推断任何元素类型。
• 对象数组会合并为一个命名类型；任何元素中缺失的字段将自动变为可空。

谁在使用它

• 后端工程师将 REST 接口或 JSON 文件封装在 GraphQL 网关中。
• 前端开发者在 API 准备就绪前，使用固定数据进行模式原型设计。
• API 设计师将第三方响应形状作为类型合同进行文档化。
• 需要从稳定 JSON 样本生成可重复 SDL 艺术品的代码生成流水线。