跳到主要内容

AI补全Schema

功能概述​

AI补全Schema功能通过智能分析JSON数据结构，字段名语义分析，自动为Schema补充字段描述、示例值、默认值等关键信息，显著提升Schema编写效率和数据定义质量。

核心能力​

🔍 智能推断 - 通过字段名和数据结构自动推断语义
📝 描述生成 - 自动生成专业准确的字段描述
🎯 示例补全 - 提供符合业务场景的示例值
⚡ 效率提升 - 减少70%以上的手动输入工作
🔄 智能推荐 - 基于上下文推荐合适的默认值

适用场景​

  • API接口文档编写
  • 数据模型设计

使用步骤​

1. 选择一个需要补充的schema​

可以对已有的数据结构进行补全，或者新建一个数据结构。 例如新建一个数据结构，导入下方的json：

{
  "user": {
    "id": 1001,
    "name": "张三",
    "email": "zhangsan@example.com"
  }
}

image.png

2. 点击"AI补全"按钮​

系统自动生成补全示例值、默认值和字段描述信息。 注意：仅补全为空的信息，如果有数据则跳过

image.png

3. 人工校验与调整​

  1. 检查自动生成的数据是否准确
  2. 可进行手动的二次修改（可选）

image.png

4. 保存补全后的schema​

警告

在保存时会有一个选项 同步更新补全所有【引用模型】的数据
当模型有引用其他模型时，在AI补全时会一同进行补全，勾选此选项在点击确定保存时，被引用的模型数据也会变更修改 如果不想修改引用的模型数据，取消勾选即可，这样只会修改当前模型中的字段

image.png

常见问题​

Q: 点击确定后，是否直接保存的数据​

A: 如果有引用模型，被引用的模型会被直接保存，而当前模型中的字段需要再次点击【保存模型】或者【保存接口】才会生效

image.png

Q: 如何保证示例值的合理性？​

A: 系统会：

  1. 分析字段名语义
  2. 参考现有值模式
  3. 应用行业惯例
  4. 支持用户手动修正

技术支持​

如有问题或功能建议，请联系我们的技术支持团队或访问开发者社区获取帮助。