跳到主要内容

API Helper

AI Helper 支持覆盖参数命名、补全文档、生成模拟数据和更新参数值等多种常见场景，极大地提升开发效率。它能够智能分析接口参数，自动为您规范命名，并完善文档内容，省去重复劳动。

规范化命名参数​

  • 使用场景： 在以API设计为优先的环境下，首先需要设计接口的请求和响应参数。
  • 解决问题： 常常为参数命名苦恼，缺乏标准化的命名规则和足够的词汇储备。
  • 使用方法： 只需描述您希望命名的参数或相关场景，AI即可为您生成规范化的参数名称，您还可以指定希望遵循的命名规范。点击复制即可使用

image.png

AI生成模拟数据​

  • 使用场景： 在接口调试过程中，需要一些符合真实业务场景的数据以进行测试。
  • 解决问题： 真实数据的缺乏和无法满足所有场景的mock数据生成，使得调试过程复杂且繁琐。
  • 使用方法： 描述您的需求及业务场景或输入参数名称，AI将快速为您生成模拟数据，助力接口调试。

image.png

批量更新参数值​

  • 使用场景： 在接口调试时，为了保证数据符合真实业务场景，可能需要批量更新参数值。
  • 解决问题： 使用mock数据功能无法覆盖所有场景，手动操作的流程冗长而繁琐。
  • 使用方法： 直接描述您的需求或输入参数名称，AI将迅速帮助您批量更新符合情境的参数值。

image.png

image.png

批量补全参数描述​

  • 使用场景： 在完成请求和响应参数设计后，可能需要快速补全参数描述信息。
  • 解决问题： 手动填写描述内容既繁琐又低效，常导致工作流程的拖延。
  • 使用方法： 选择需要补全的参数位置，勾选相关key，AI将自动生成参数描述，您只需一键同步至接口即可。

image.png

image.png

image.png

一键补全文档​

  • 使用场景： 在日常调试接口的过程中，往往都是快速输入接口信息并进行测试。许多开发人员常常忽略或懒得填写接口文档中的详细信息，因为这会占用他们宝贵的时间和精力。
  • 解决问题： 手动填写文档往往耗时而繁琐，而接口调试的步骤需要快速进行，使用此功能可轻松提高文档填写的效率，确保文档与接口信息同步。
  • 使用方法： 仅需一键点击，AI将自动生成接口文档的相关内容，生成完成后，您可以直接保存或选择分享，从而节省时间，专注于改善和优化代码。

image.png

image.png