开发手册
JSON 转代码模型
对着接口返回的一个大 JSON 手写实体类,写漏一个字段就要重来。把 JSON 粘进来,结构、类型、字段名交给它推断。
① 粘贴 JSON
② 复制代码
使用说明
它解决什么问题
接口返回的 JSON 动辄几十个字段、三四层嵌套,照着屏幕一行行手抄成 interface 或 struct,最容易出两种错:漏字段,以及把 null 写成必填。工具把这件事变成一次性动作,字段名一个都不会走形。
怎么用
- 把接口返回的 JSON 整段粘到左边,最好多带几条记录,样本越全推断越准。
- 需要改根类型名就改,默认是 Root,改成业务名更顺手。
- 在右边切换语言,点「复制」直接贴进项目;也可以下载成文件。
推断规则
- 同名对象合并:数组里每个元素都叫 Item,字段取并集;某个元素缺字段时,这个字段标记为可选。
- 类型冲突:同一字段既出现字符串又出现数字,生成联合类型(Go、Java 退化为 interface{} / Object)。
- null:与其它类型合并时变成可空,例如 TypeScript 的 string | null。
- 整数与小数:勾选后 1 是 int、1.5 是 float,Go 相应输出 int64 与 float64。
- 空数组 / 空对象:没有元素可推断,输出 any[]、Record<string, unknown> 这类宽松类型。
字段名怎么处理
原始字段名不会被改写。user-name 在 TypeScript 里是 "user-name",Go 里标识符转成 UserName 但 tag 仍是原值,Java 加 @JsonProperty,Swift 通过 CodingKeys 映射,序列化时不受影响。
注意
类型来自样本,不是契约。接口可能返回样本里从未出现过的字段,或者把数字写成字符串;拿到模型后再对照接口文档过一遍,比直接上线更稳妥。
常见问题
生成的类型准确吗?
类型完全由样本推断:同一个字段在不同样本里出现不同类型时会合并成联合类型,样本里没出现过的字段自然不会生成。把真实接口返回的数据(最好包含几条不同形态的记录)整体粘进来,准确度最高。
字段名带横线或中文会怎样?
不会破坏原始字段名。TypeScript 给非法标识符加引号,Go 用 json tag,Java 用 @JsonProperty 注解,Python 用下划线命名并在注释里标注原名,Swift 用 CodingKeys 映射。
支持哪些语言?
目前支持 TypeScript(interface)、Go(struct 带 json tag)、Java(类与 Jackson 注解)、Python(dataclass 与 typing)、Swift(Codable struct 与 CodingKeys)五种。
数组里有多种结构的对象怎么办?
同名字段会合并类型,某个对象缺少的字段标记为可选;如果两个对象的字段完全不重叠,会合并成一个包含全部字段的结构,缺的字段同样按可选处理,不会丢信息。
JSON 会上传到服务器吗?
不会。解析、推断与生成全部在浏览器里完成,页面没有任何上传请求。涉及内部接口结构的 JSON 可以放心粘贴,断网后这个工具同样能正常工作。