📝
FormaX Team2026年五月18日5 分钟
从示例 JSON 生成 Schema:API 与 LLM 结构化输出指南
用一份示例 JSON 推断草稿 Schema,AJV 校验实例,并复制 OpenAI / Anthropic 结构化输出代码片段。
JSONJSON SchemaAPI
API 开发者为什么需要 JSON Schema
OpenAPI、网关校验、客户端 SDK 生成都依赖「数据长什么样」的契约。手写 Schema 枯燥且易与真实 payload 脱节;从一份真实示例反推草稿,再人工收紧规则,是团队里最高效的路径之一。
从示例推断:能做什么、不能做什么
工具会根据示例值的类型推断 type、嵌套 object、array 与必填字段。它不会猜出业务规则(如枚举全集、字符串格式、数值范围)——这些仍需你编辑 Schema 或使用 enum、pattern、minimum 等关键字补充。
用 AJV 校验实例
生成 Schema 后,粘贴待测 JSON,一键验证是否匹配。在 CI 里可把同一份 Schema 用于请求体校验,减少「文档写了、线上挂了」的情况。
LLM 结构化输出
大模型返回自由文本时难以直接入库。OpenAI 的 response_format: json_schema 与 Tools 里的 function parameters、Anthropic 的 tool input schema,都要求合法的 JSON Schema。FormaX 工具在推断后会生成可复制的片段,减少对照文档手敲。
推荐流程
- 从日志或文档复制一份典型成功响应作为示例。
- 在 JSON Schema 工具 中生成草稿并审阅。
- 补充
description、枚举与格式约束。 - 用校验 tab 覆盖边界用例(缺字段、错误类型)。
- 将 Schema 同步到 OpenAPI、网关与 LLM 提示词。
推断与校验均在浏览器本地执行,适合含敏感字段的响应样本。立即使用 JSON Schema 工具。