JSON Schema 生成表单

根据 JSON Schema 自动生成可以填写的表单:不同类型和格式的字段生成对应的输入框、下拉框和开关,嵌套对象生成分组,数组可以增删条目。填写时按 Schema 实时校验,在字段下方显示中文错误,并同步输出 JSON 数据;也可以导出不依赖框架的 HTML 表单代码。

编辑 Schema(当前为示例:服务器配置)

Schema 与表单控件的对应关系

Schema生成的控件
"type": "string"文本框;maxLength 超过 200 时为多行文本框
"format": "email" / "uri" / "date" / "date-time"邮箱、网址、日期、日期时间输入框,手机上会弹出对应的键盘
"enum": [...]下拉框,enum 中的值就是选项
"type": "number" / "integer"数字输入框,minimum、maximum、multipleOf 会成为 min、max、step
"type": "boolean"复选框
"type": "object"分组(fieldset),properties 中的字段依次排列
"type": "array"可以增删的条目列表;元素是 enum 时为多选
title、description、default、required字段标题、说明文字、默认值、必填标记(*)

正式项目中可以使用 react-jsonschema-form、JSON Forms、vue-json-schema-form 等成熟的库,它们支持自定义布局(uiSchema)和更多控件。校验单条数据请用 JSON Schema 验证器,从示例数据生成 Schema 请用 JSON Schema 生成器。

JSON Schema 生成表单常见问题

JSON Schema 生成表单怎么使用?

默认使用示例 Schema,展开“编辑 Schema”可以粘贴自己的 Schema;左侧会生成表单,填写时实时校验,错误显示在字段下方,数组字段可以添加和删除条目;右侧切换 JSON 数据或 HTML 表单代码复制。

怎么根据 JSON Schema 生成表单?

粘贴 Schema 后左侧会自动生成表单,填写的数据同步显示在右侧。

表单校验规则从哪里来?

全部来自 Schema 中的 required、minLength、pattern、minimum、format 等关键字。

可以导出表单代码吗?

切换到“HTML 表单代码”即可复制使用原生 HTML 校验属性的表单。

正式项目用什么库?

React 可以用 react-jsonschema-form,Vue 可以用 vue-json-schema-form 或 JSON Forms。

JSON Schema 生成表单的结果应怎样理解?

支持常用的类型、格式、枚举、嵌套对象和数组,以及文档内的 $ref;oneOf、anyOf 等组合规则只参与校验,不会生成可切换的表单;导出的 HTML 不包含数组增删的脚本。

输入内容会保存或发给外部服务吗?

Schema 和填写的数据只在浏览器本地处理,不会上传。

没有结果或操作失败时先检查什么?

表单没有生成时,检查 Schema 是否是合法的 JSON,且顶层 type 为 object。

相关工具

JSON Schema 验证器 · JSON 对比 · JSON 补丁工具 · JSON Schema 生成器 · 全部开发工具