JSON Swiss 标志

JSON Swiss

TypeScript → JSON Schema 生成器

TypeScript 代码 输入

正在加载编辑器…

JSON Schema 输出

设置

选择作为 JSON Schema 根的 interface/type。

解析完全在浏览器内完成，源码不会离开此页面。

粘贴 TypeScript types，立即生成 JSON Schema。

支持 interfaces、type aliases、public class fields、optional/readonly 与 union types。

如何将 TypeScript interface/type/class 转为 JSON Schema（步骤指南）

这个在线 TypeScript → JSON Schema 转换器可以从真实模型（DTO、struct、class）生成 JSON Schema，方便校验 payload、共享合同，并生成 Mock JSON。

  1. 步骤 1：粘贴 TypeScript（TS） 源码

    • 将需要文档化的模型粘贴到左侧编辑器。
    • 把被引用的类型也放在同一段代码里，便于生成 definitions。
    • 点击 示例 查看示例输入格式。

  2. 步骤 2：选择 根类型（如需要）

    • 如果检测到多个定义，选择与 API payload 对应的根类型。
    • 输出 Schema 会以选中的根类型为中心，并包含引用类型的额外 definitions。

  3. 步骤 3：检查输出的 JSON Schema

    • 重点检查类型、必填/可选字段，以及嵌套对象/数组结构。
    • 当模型引用其他模型时，注意 definitions 以及 $ref 是否正确。
    • 复制或下载 Schema，用于校验、文档或 schema-first 开发。

  4. 步骤 4：校验或生成 Mock JSON

    • 点击 生成 Mock 数据 即可打开已预填 Schema 的 Mock 生成器。
    • 用真实 payload 校验 Schema，尽早发现破坏性变更。
    • 如果你依赖更高级的 Schema 组合（例如 anyOf/oneOf/allOf），建议用 Ajv 等完整校验器再验证一遍。

Schema 关键字支持说明

生成的 Schema 可能包含 $ref ，也可以按需补充 anyOf, oneOf, 或 allOf。当 Schema 更复杂时，建议使用完整的 JSON Schema validator；如需生成 Mock 数据，可先 dereference 再生成。

相关工具

搭配这些工具一起使用：校验 Schema、生成 Mock payload、格式化 JSON 样例，并保持代码与合同一致。

JSON Schema Mock 数据生成器

从 Schema 生成样例 JSON，用于测试、fixtures 与文档。

JSON Schema 校验器

用常见 Schema 关键字校验 JSON，快速定位不匹配。

JSON 转 TypeScript 类型

基于 JSON 样例生成 TypeScript（TS） 类型与模型。

JSON → JSON Schema 生成器

从代表性的 JSON 样例生成 Schema，补齐 model-first 的场景。

JSON Schema 模板库

浏览对象、数组、enum 与约束模式的 Schema 示例。

JSON 格式化

校验 Schema 或共享文档前，先清理并规范化 JSON 样例。

常见问题

支持哪些 TypeScript 语法？

支持 interfaces、type aliases，以及包含 public fields 的 classes。可处理 optional properties、readonly、字符串字面量 key、union types、arrays、Record 类型与嵌套引用。会忽略注释与 decorators，便于直接粘贴项目里的 DTO。

类型映射如何工作？

string/number/boolean/bigint/Date 等基础类型会映射到 JSON Schema primitives（含 formats）。Foo[]/Array<Foo>、Record<string, T> 以及字典形态会映射为 schema arrays/objects。包含 null/undefined 的 union type 会自动把字段标记为可选。

class 和 interface 都能用吗？

可以。只要 class 定义了带类型注解的 public fields（或 readonly properties），就可以转换为 JSON Schema。工具完全在浏览器本地运行，代码不会上传。

如何从 Schema 生成 Mock JSON？

生成 Schema 后，点击“生成 Mock 数据”打开已预载 Schema 的 Mock 生成器，配置 locale、数组大小与可选字段，即可快速生成样例 payload。

TypeScript → JSON Schema 生成器 | JSONSwiss