工具用的顺手吗?
你的反馈能帮助我们做得更好
将JSON数据结构自动转换为Smithy IDL模型定义,简化API设计与服务建模流程。
概览
了解工具能解决的问题、计算或处理逻辑,以及数据边界。
一份订单 JSON 可以作为结构建模的起点:工具读取合法 JSON 样本,按样本中可见的键和值推断类型,并输出 Smithy 模型文本。Smithy 是用于描述服务接口与数据模型的建模语言;它的模型可以用易读的 Smithy IDL 表达。生成结果适合继续编辑,不代表完整 API 规范已经设计完成。
顶层类型名默认为 Root,可自行更改;Smithy 页面还提供“仅生成类型定义”选项。JSON 修改后,输出会重新生成,完成后可以复制或下载带有 .smithy 扩展名的文本文件。
Smithy 把数据模型中的基本类型和聚合类型组织成形状。常见的 structure 用来描述一组具名成员;list 表示同类成员的有序集合;map 表示按键映射的集合。JSON 对象或数组提供的是样本结构,生成器据此推断候选形状与成员类型,仍需要建模者确认字段含义、命名和业务约束。
这一步只把示例数据转为模型草稿。Smithy IDL 的语法与形状定义有正式规范;字段是否必填、允许哪些取值、如何描述操作和认证等设计,不能仅靠一份 JSON 样本得出。
例如样本包含订单编号和明细数组,生成结果应保留编号成员,并表达明细的嵌套结构。若样本把明细数组留空,数组中没有可供推断的成员字段;需要补充代表性对象,或按接口契约手动确认列表成员类型,不能根据数组名称推断完整结构。
指南
按步骤完成操作,并通过示例核对输入与结果。
粘贴可解析的 JSON 对象或数组,保留需要建模的字段和值类型。字段名须使用双引号,字符串值也要用双引号,最后一个成员后不要留下多余逗号。
将默认的 Root 改成能表达样本用途的名称,例如 Order 或 Profile。若只需要模型类型定义,可检查“仅生成类型定义”选项。
对照输入逐项检查成员名称和推断类型,再复制输出或下载 .smithy 文件。需要进入项目时,应使用 Smithy 校验流程检查语法和模型约束。
场景
查看这项工具在不同工作与生活流程中的用法。
开发者可把已有 JSON 响应样例转为初始结构,再据此讨论字段名、列表成员与嵌套对象。样本明确的是当次响应形状,并不自动代表所有响应状态。
在已有服务资料缺少统一数据模型时,可先选一份可公开的样本生成文本草稿,交由接口维护者补上语义说明、限制条件和操作定义。
问答
集中解答高频疑问与容易混淆的问题。
不是。它按 JSON 样本生成数据模型草稿;服务、操作、鉴权、字段约束和说明仍需结合实际接口补充,并按团队的 Smithy 版本与规则校验。
单份样本只展示一次取值。它不能证明字段在其他响应中不会缺失,也无法覆盖同一字段的全部取值形态;请对照接口文档补齐可选字段、空值与变体。
先确认输入是完整 JSON,括号成对、字符串使用双引号且逗号位置正确。修复语法后再检查错误提示;有效 JSON 也仍可能需要手动修改不符合业务语义的类型推断。
须知
使用前了解适用范围、结果限制与必要提醒。
输入只提供一个 JSON 样本,空数组、空对象、字段缺失和多种取值都可能使类型推断信息不足。对必填性、可空性、字段范围和跨版本兼容的判断,应查阅实际接口契约并人工审阅。
生成文本不应直接作为上线依据。部署前请用项目采用的 Smithy 工具链校验模型,并补齐命名空间、文档说明、约束特质、服务与操作等所需定义。转换在当前页面根据输入样本完成;粘贴真实业务数据前,建议移除个人信息、密钥和令牌。
推荐
查找相关工具、专题与可用的 API 能力。