关键信息
- 分类
- Development
- 输入类型
- textarea, select, checkbox
- 输出类型
- json
- 样本覆盖
- 4
- 支持 API
- Yes
概览
JSON Schema 生成器是一款专为 API 开发者和数据工程师设计的实用工具,能够根据您提供的示例 JSON 数据自动推断并生成对应的 JSON Schema,并支持手动调整与实时校验,确保数据结构定义准确无误。
适用场景
- •需要为现有的 API 响应数据快速编写规范化的 JSON Schema 时。
- •在进行数据建模或定义接口契约,需要从示例数据提取结构定义时。
- •修改了 JSON Schema 定义后,需要立即验证其是否兼容原始示例数据时。
工作原理
- •在“示例 JSON”区域粘贴您的数据对象。
- •勾选“从数组推断枚举”或“识别常见格式”以增强 Schema 的精确度。
- •点击生成后,系统将自动推断出 Schema,您可直接在“调整后的 Schema”中进行手动优化。
- •开启“使用当前 Schema 校验示例数据”功能,即可实时确认 Schema 与数据的匹配状态。
使用场景
用户案例
1. API 响应结构建模
后端开发工程师- 背景原因
- 需要为新开发的 REST API 编写 OpenAPI 文档,但手动编写复杂的嵌套 Schema 容易出错。
- 解决问题
- 快速从现有的 API 响应示例中提取出准确的 Schema 结构。
- 如何使用
- 粘贴 API 响应 JSON,勾选“识别常见格式”,生成后直接复制 Schema 到 Swagger 文档中。
- 示例配置
-
{"draft": "2020-12", "detectFormats": true} - 效果
- 获得了一份包含正确数据类型、嵌套对象定义及格式校验的 JSON Schema,大幅提升了文档编写效率。
用 Samples 测试
json相关专题
常见问题
该工具支持哪些 JSON Schema 草案版本?
目前支持 2020-12 和 Draft-07 两个主流版本,您可以根据项目需求在选项中进行切换。
“从数组推断枚举”有什么作用?
开启此项后,如果数组中的元素是固定的字符串或数字,工具会自动将其转换为 enum 类型,限制字段的可选值范围。
我可以手动修改生成的 Schema 吗?
可以。生成后您可以直接在“调整后的 Schema JSON”输入框中进行编辑,并重新运行校验以确保逻辑正确。
工具如何处理日期或邮箱等特殊格式?
勾选“识别常见格式”后,工具会自动检测字符串内容,若符合标准格式,将自动在 Schema 中添加 format 属性(如 date-time 或 email)。
校验功能会返回什么结果?
校验功能会返回一个包含验证状态的 JSON 对象,明确指出当前 Schema 是否能够成功验证您提供的示例数据。