第一步:准备JSON示例数据
在使用工具之前,请先准备好一份具有代表性的JSON示例数据。数据应当包含您期望的所有字段及其典型值,确保结构完整。例如,如果您需要为用户API生成Schema,可以准备一个包含用户ID、姓名、邮箱、年龄等字段的JSON对象。推荐使用JSON验证工具对数据格式进行预检查,确保数据格式正确无误。
第二步:粘贴JSON数据
在工具页面的输入区域中,粘贴您准备好的JSON示例数据。您可以手动输入,也可以通过复制粘贴的方式将数据从其他编辑器或API文档中导入。工具会自动识别输入内容并实时分析数据结构,等待您点击生成按钮后完成Schema的生成。
第三步:选择Schema版本
在生成配置区域,选择您需要的JSON Schema版本。目前提供Draft-07和2020-12两个选项。如果您使用AJV(Another JSON Validator)等验证器,建议选择Draft-07;如果项目使用最新的Schema规范且验证器支持2020-12,则可以选择后者。版本选择会影响生成结果中使用的关键字和语法格式。
第四步:生成Schema
点击「生成Schema」按钮,工具将自动分析JSON数据并生成对应的Schema定义。生成过程包括:解析JSON数据结构、推断每个字段的数据类型、识别必填字段、处理嵌套对象和数组、生成符合所选版本的Schema格式。整个过程在毫秒级别完成,即使处理包含数百个字段的复杂JSON也能快速响应。
第五步:查看和调整结果
生成的Schema会显示在结果区域,以格式化后的JSON形式呈现。您可以检查生成的Schema是否准确反映了数据结构。如有需要,可以手动调整Schema内容,例如添加字段说明(description)、设置默认值(default)、定义枚举值(enum)、添加最小值最大值约束等,使Schema更加精确完善。
第六步:复制或导出
确认Schema无误后,点击复制按钮将Schema内容复制到剪贴板,然后粘贴到您的API文档、代码文件或Schema存储库中。也可以点击下载按钮将Schema保存为.json文件。导出的文件可以直接用于数据验证工具或API框架的配置,如OpenAPI规范中的components.schemas定义。
UD5工具箱