当您手动添加操作时,必须通过添加路径和查询参数、标头、请求和响应来配置操作详细信息。

在导入 API 定义时,您需要验证并编辑操作详细信息,以确保操作根据您的要求具有适当的值。 使用该软件包时,这些详细信息将在 机器人编辑器API 任务 编辑器中显示。 当您添加一个操作时,操作配置页面会显示。 配置选项卡显示各种配置设置,而测试选项卡允许您对该操作进行测试。 以下设置可在配置选项卡中使用。

配置选项卡中的设置

HTTP 方法
指定必须发送到 REST API 服务器的 REST 请求类型。 支持下列 HTTP 方法:
  • GET
  • PUT
  • POST
  • DELETE
  • PATCH
注: 导入 API 定义时,连接器编辑器会忽略不支持方法的操作,并将其余操作包含在自定义连接器中。
端点
请输入您用于此操作的端点 URL。 软件包用户无法看到此 URL。 在 URL 中使用大括号 {} 来括住路径和查询参数。 例如,/{version}/product/{productid}?status={productStatus}
完整 URL
此只读字段显示一个自动生成的字段,该字段组合了您在创建软件包时输入的基础 URL 和来自 Endpoint 字段的端点 URL。 该 URL 对软件包用户不可见。
请求参数
请求参数使您能够识别、排序和筛选来自 API 服务器的响应。 使用添加参数选项来添加请求参数。 您可以添加路径和查询参数。 确保参数与 Endpoint URL 路径匹配。 有关添加请求参数的更多信息,请参阅 请求参数
请求标头
请求标头允许您向请求中添加附加信息。 您可以添加请求标头,例如 AcceptContent-LengthContent-TypeCookie。 有关添加请求标头的更多信息,请参阅 请求标头
请求正文
请求正文允许您导入示例有效载荷,以定义请求正文的结构。 有效载荷是指在 API 服务器中创建、更新或删除资源所需的实际数据。 当操作运行时,请求会包含此有效载荷。 有关添加请求正文的更多信息,请参阅 请求正文
以下选项可供选择:
  • JSON: 选择此选项以导入 JSON 示例,以映射请求正文属性。 将捕获叶节点并将其在此处显示为属性列表。 JSON 通过其键值对结构提供了灵活性。 有关请求正文中 JSON 选项的更多信息,请参阅 JSON
  • 表单数据: 选择此选项可将表单数据参数作为请求正文属性添加。 表单数据选项对于通过指定内容类型将文件上传到 REST API 服务器非常有用。 有关表单数据选项的更多信息,请参阅 表单数据
  • 表单 URL 编码数据: 选择此选项可在 HTML 表单中以 URL 编码的键值对形式添加请求正文参数,方式类似于查询类型请求参数。 有关表单 URL 编码数据的更多信息,请参阅 表单 URL 编码数据
响应
响应选项允许您从响应中导入示例有效载荷,并选择要在 机器人编辑器API 任务 编辑器中显示的属性。 有关添加响应参数的详细信息,请参阅 响应