API 节点
更新时间:2025-03-10
整体概述
支持接入遵守RESTful架构规范并采用标准认证机制的API。API接入前需要已经完成服务化,确保所有接入的API均遵循RESTful架构规范,确保使用无状态的请求模型并通过HTTP标准方法(如GET、POST、PUT、DELETE)进行资源操作,同时接口使用标准的认证机制。此外,接口设计符合OpenAPI规范,接入的API已经过性能测试、安全审查和兼容性检测,以确保API的稳定性和可靠性。同时为确保模型调用组件的最终效果,当前接口参数层级不支持超过10层。
使用说明
- 添加API节点,可以手动逐步配置API基本信息或通过curl命令一键导入。配置信息包括:请求参数和响应参数。您可以只填写必需的请求参数和响应参数。比如在返回参数配置中,若需输出返回数据中某个对象的完整内容,仅需设置最顶层参数信息并选择适当的参数类型。
- 配置完成请求参数和响应参数后,点击【发送】,进行接口请求,下方将展示对应接口的原始API返回信息,和按照响应参数配置获得的参数返回信息,您可以检查返回信息是否符合预期。
- 您也可以不配置响应参数,直接根据API请求结果的返回信息自动解析输出参数,平台解析规则说明:当前支持接口返回内容类型有:JSON、XML、HTML、Plain Text、YAML、CSV。其中JSON、XML、YAML可被解析为JSON输出,便于您在后续节点引用某个参数或属性,其余类型支持以整个string类型输出。API接口返回内容大小不能超过1M。
- 在完成API原始信息编辑后,您需要继续在右侧面板中对输入参数进行值配置,可以引用前序节点输出,或手动输入对应参数值。需要确保引用类型与设置类型一致。
- API节点支持接入流式接口,要求接口返回的streaming event格式为:"data:" {"xxx":"xxx"},要求数据帧data是全量的,暂不支持第一帧数据不全,支持JOSN嵌套的流式信息返回。
- API节点的http请求发送成功即为接口调试通过,在整体流程调试前,API节点需要为调试通过状态。