在JVS中,多数据源支持多种形态的数据接入,其中API是企业生产过程中常见的数据形态。使用数据源的集成配置,以统一的方式管理和集成多个API的数据。这些平台通常提供各种数据转换和处理功能,使得从不同数据源获取和处理数据变得更加简单和高效。文章末尾附有规则引擎配置API的demo视频。
API数据源界面介绍
下图展示在多数据源下的API配置界面,其中包括左侧的API数据源管理,右侧展示配置详情
①:表示数据方,往往数据方可能提供多个API接口
②:表示在左侧数据方提供的接口明细
③:数据方配置的基本信息
创建API数据源
选择API数据源目录上的"+"新增数据源按钮
系统进入添加API数据源配置界面,如下图所示:
①:API数据源的基本名称,一般常用于数据提供方的记录,表示数据提供的来源,一般同一个数据源有多个数据接口
②:选择jar,这里选择jar包是一个可选项,如果这个接口访问有特殊的业务处理逻辑,可以通过独立的jar包实现复杂定制化的业务逻辑
③:静态请求头的参数配置,如果配置,那么本数据方下的所有接口请求头都会携带该配置数据项
完成数据方配置后,系统将在左侧菜单上形成对应数据方的记录。
数据接口连接配置
在完成数据方的配置后,可以增加这个数据提供方下的接口,如下图所示,点击添加
选中对应数据方,进入接口列表管理页面, 点击添加按钮,进入接口配置界面
①:展示了配置api需要两个步骤,第一步配置api的连接配置,第二步完成数据解析的设置
②:设置接口的名称
③:设置该接口请求的方式,post/get
④:设置请求回来数据是否存在分页的情况,如果存在开启分页设置
⑤:设置入参请求参数
⑥:其他参数主要用于通过jar进行数据特殊处理时所需要的参数
- 填写 API 数据表的基础信息,包括名称、完整的请求地址和请求方式,请求方式支持 GET 和 POST;
- 如果开启分页设置,系统会展示分页数量,分页数量默认"-1"表示无限制,可以对端接口具体要求设置单页多少条,另外系默认新增两个入参字段,size(单页多少条)与current(当前第几页)
参数设置,参数包括参数名称,字段展示名称,字段的类型,必填标志,参数使用的场景等(路径、请求头、请求体)
数据结果提取配置
在完成接口连接配置后,可以点击下一步按钮,系统进入提取数据结果的配置
进入结果提取配置界面如下图所示:
①:展示接口配置进展情况
②:获取指定json格式的业务结果(如果无法在线获取对端返回结果的情况下使用)
③:接口获取数据成功的状态数据
④:返回数据中,使用者关注的数据
⑤:展示返回回来的数据结果
⑥:以json的方式预览数据结果
API接口自定义JAR包管理
对于api需要自定义处理业务逻辑的情况下,通常采用自定义jar包的方式进行处理,一般下列情况下可能都采用自定义jar
- 具备有效期的动态token
- 参数传递不规范
- 返回值具有特殊加解密
- 特殊数据脱敏处理
- 来回多次交互
jar包管理页面管理入口如下图所示:
点击设置,进入jar包管理界面,jar包管理包括增删改,如下图所示