用 JSON Schema 定数据契约简直是开发者的噩梦

PromptCube 中级 3小时前 124 浏览 4 点赞 约 1 分钟

给产品经理或者运营看 JSON Schema 的代码,对方基本一脸懵逼,但如果直接让他们改代码,大概率会把整个格式搞崩。这种技术文档和业务需求之间的断层,其实就是典型的沟通成本问题。

我发现 JSON Schema 虽然是目前最通用的数据描述标准,但它的可读性实在太差。为了解决这个问题,我试着搞了一个叫 Schemagic 的可视化编辑器,核心逻辑就是把那些枯燥的 JSON 结构变成直观的视觉界面,让不懂代码的人也能参与到数据契约的定义中,而不需要在编辑器里对着括号和引号发呆。

对于习惯了 OpenAPI 或者各种验证库的开发者来说,这个工具的实操逻辑很简单,它本质上是在可视化界面和标准的 JSON Schema 之间做了一层实时映射。

如果你现在正面临这种场景,可以尝试按照这个流程跑一下:

一、将现有的 JSON Schema 文本直接粘贴进编辑器,它会自动解析成可视化的字段树。
二、通过拖拽或简单的表单输入,修改字段类型、添加约束条件(比如 maxLength 或 minimum)。
三、实时查看右侧生成的标准代码,确认无误后直接导出到你的项目中。

这种方式比在 Git 里通过 PR 来反复修改一个 JSON 配置文件要高效得多。毕竟,让业务方在界面上点选“必填”或“可选”,比让他们在代码里写 "required": ["field_name"] 要靠谱得多。

OpenAPISchemagicJSON Schema

全部回复 (3)

大鹏的日常 初级 3小时前
确实,能直接导出成TS类型定义吗?
0 回复
深漂独立开发者 中级 3小时前
之前给运营对接口,对着文档吵半天,得画图他们才明白。
0 回复
创业者阿杰 中级 3小时前
我平时习惯配合Ajv做前端校验,不然得写一堆if判断。
0 回复

发表回复

支持 Markdown 格式