跳到主要内容

AI补全参数描述与参数值

通过AI智能推荐，快速补全接口参数的描述信息，解决手动填写繁琐且效率低下的问题，确保参数文档更加规范、准确。

AI补全​

  • 使用场景： 当存在参数名称但缺少对应的参数值或参数描述时，传统需要手动逐一填写和维护，效率较低且易出错。
  • 解决痛点： 彻底避免繁琐的手动操作，提升填写速度与准确性。
  • 使用方法： 只需一键点击，AI即可智能识别参数名的语义，自动补全对应的参数值和参数描述，极大简化维护流程。

使用方法​

普通的form表单​

当需要为Header、Query 、Path、Body（form-data、urlencoded）、Cookie 补全参数描述等信息时：

  1. 在表单的右上角点击 批量补全。同时这里也可以进行批量编辑、批量导入
  2. 点击 AI补全 按钮，即可进行补全
  3. 最后点击确定，即可同步补全后的信息

image.png

image.png

Body为raw格式​

当body为raw格式时，支持直接在json中填写注释，例如：

{
    "name":"Jhon", //用户姓名
    "age":"34"
}
  1. 点击字段描述，会自动提取json中的注释作为参数描述信息
  2. 然后点击批量补全，可以对缺少的注释信息进行补全
  3. 点击确定即可同步

image.png

image.png

image.png