指南

从 JSON 一键生成 TypeScript、Zod 与 Pydantic v2 强类型定义

在本地将 API JSON 样本转化为嵌套 TypeScript 接口、Zod 运行时校验器与 Python Pydantic v2 模型,自动推断可选字段与别名。

2 分钟阅读

快速解答: 从真实 API JSON 响应直接推断生成 `TypeScript` 接口、运行时 `Zod` 校验器与 Python `Pydantic v2` 模型,可在编译期与运行期同时拦截字段缺失与类型漂移。TxtTo 在浏览器本地自动识别联合类型、可选属性与嵌套对象,确保业务数据结构零外泄。

为什么在 API 边界仅有编译期静态类型还不够

TypeScript 接口在代码编译成 JavaScript 后就会被完全擦除。一旦外部 Webhook 改了字段名或意外返回 `null`,静态接口本身无法在运行期拦下异常,直到页面崩溃才暴露问题。

将静态 TypeScript 模型与运行时校验器(JS/TS 生态用 Zod,Python 生态用 Pydantic v2)结合起来,才能真正守住全链路数据契约。

从 JSON 数组智能推断可选属性 (?) 与联合类型

真实 API 返回的对象数组很少在第 0 条就包含全部可选属性。“JSON 转 TypeScript”会遍历扫描数组中每一个元素,自动合并所有键并对部分记录缺失的键标记 `?`。

ts
export interface EventItem {
  id: string;
  retries?: number;
  error: string | null;
}

从 JSON 生成 TypeScript 接口

用 Zod 实现运行时校验与 z.infer 单一类型源

与其手写重复的接口和校验代码,不如用“JSON 转 Zod”直接生成嵌套 `z.object(...)` 校验器及 `export type RootSchema = z.infer<typeof rootSchema>`,让运行期校验与编译期类型保持同步。

生成 Zod 运行时校验 Schema

生成带 Field 别名的 Python Pydantic v2 BaseModel

Web API 常用 `camelCase` 驼峰命名,而 PEP 8 规范的 Python 代码惯用 `snake_case` 下划线。“JSON 转 Pydantic”会自动将嵌套对象提升为独立模型类,生成 `Optional[...]` 注解并自动附带 `Field(alias="camelKey")`。

python
class RootModel(BaseModel):
    user_id: str = Field(alias="userId")
    is_active: bool = Field(alias="isActive")

在本地生成 Pydantic v2 模型

参考资料

常见问题

遇到带短横线的 JSON 键名或 Python 保留字怎么处理?

生成器会自动清洗转义:TypeScript 会用引号包裹非法标识符键名,Pydantic 则将其映射为合法 snake_case 属性并附加 Field(alias=...)。

生成的 Zod Schema 应该开启“严格对象模式”吗?

契约测试或内部强约束接口建议开启;若对接经常新增冗余字段的第三方外部 API,保持关闭以便平滑兼容未知字段更稳妥。

可以先修复整理杂乱的 JSON 再生成模型代码吗?

可以。先在“JSON 格式化”中修复尾随逗号并查看树视图,然后直接点击“继续下一步 -> JSON 转 TypeScript”。

相关格式

相关方案对比

相关指南