Scala case class → JSON Schema 生成器

Scala 代码 输入

正在加载编辑器…

JSON Schema 输出

设置

选择作为 JSON Schema 根的 case class。

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

粘贴 Scala case classes,立即生成 JSON Schema。

支持 Option[T]、collections、maps、嵌套 case classes 与默认值。

如何将 Scala case class 转为 JSON Schema(步骤指南)

这个在线 Scala case class → JSON Schema 转换器可以从真实模型(DTO、struct、class)生成 JSON Schema,方便校验 payload、共享合同,并生成 Mock JSON。

  1. 步骤 1:粘贴 Scala 源码

    • 将需要文档化的模型粘贴到左侧编辑器。
    • 把被引用的类型也放在同一段代码里,便于生成 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 样例,并保持代码与合同一致。

常见问题

支持哪些 Scala 类型?

支持 case classes 与带构造函数参数的普通 class。可处理 Option[T]、集合(List/Seq/Vector/Array/Set)、maps、默认值与基础类型。只要相关 case class 在同一段代码中出现,就支持嵌套引用。

类型推断如何工作?

String/Int/Long/Double/Boolean/BigDecimal/Instant/UUID 等会映射到 JSON Schema primitives(含 formats)。集合 → array,maps → object,Option[T] 会标记字段为可选。未知类型若找不到同名 case class,会回退为 string。

Scala 3 或旧语法也支持吗?

支持。只要 class 定义符合标准 case class 语法即可解析。转换完全在浏览器本地完成,源码不会上传。

如何生成 Mock JSON?

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

Scala case class → JSON Schema 生成器 | JSONSwiss