无需登录 数据私有 本地保存

JSON 转 Python 数据类定义 - dict 与 dataclass 生成

53
0
0
0

完整操作指南

1
准备 JSON 数据

首先准备好需要转换的 JSON 数据。可以是 API 返回的响应体、配置文件内容或任何有效的 JSON 字符串。确保 JSON 格式正确,没有语法错误。

{"name": "张三", "age": 28, "email": "zhangsan@example.com", "tags": ["dev", "python"]}
2
粘贴 JSON 到输入区域

打开工具页面,将 JSON 数据粘贴到左侧的「JSON 输入」文本框中。也可以点击「示例」按钮加载预设的示例数据快速体验。粘贴后,工具会自动开始解析并生成代码。

支持格式化和压缩两种 JSON 格式,工具会自动识别并处理。
3
配置生成选项

根据实际需求调整配置选项:

  • null 值使用 Optional:推荐开启,生成的类型定义会包含 Optional 标注,兼容含 null 值的字段
  • 生成示例值注释:在每个字段上方添加示例数据注释,便于团队成员理解字段含义
  • 使用 __future__ annotations:添加前向引用声明,提升类型标注的兼容性
4
选择生成模式并查看结果

在右侧结果区域,通过顶部标签页切换 Dataclass 和 TypedDict 两种模式。观察两种模式生成的代码差异:Dataclass 模式包含 from_dict/to_dict 方法和 dataclass 装饰器;TypedDict 模式更简洁,直接继承 TypedDict 基类。根据项目需求选择最适合的模式。

5
复制代码并使用

点击代码区域右上角的「复制」按钮,将生成的 Python 代码复制到剪贴板。粘贴到项目的 .py 文件中即可使用。代码仅依赖 Python 标准库,Dataclass 模式需要 Python 3.7+,TypedDict 模式需要 Python 3.8+。

建议将生成的代码作为起点,根据实际业务需求微调类型标注(如将金额字段改为 Decimal 类型)。
进阶使用技巧
处理嵌套 JSON

直接粘贴包含多层嵌套的 JSON 即可,工具会自动为每一层嵌套生成独立的类定义。嵌套越深,生成的类越多,代码结构越清晰。

根节点为数组

如果 JSON 根节点是数组,工具会生成元素类型的类定义和 RootType 别名,同时提供批量转换函数。

自定义根类名

在输入框上方的「根类名称」字段中输入自定义名称,生成的主类会使用该名称而非默认的 RootModel。