API数据源登记

该数据源登记的页面如下图:

API数据源登记 - 图1

具体配置项说明如下:

  • 数据源名称:必填,API数据源的名称
  • 数据源标识:仅允许包含英文小写、数字、下划线,只允许英文小写开头,最大长度为64个字符。平台内唯一,保存数据源后数据标识不可修改
  • 归属项目:必填,由于元数据中心是项目组级别,因此此处支持选择项目组下的项目,默认为当前项目名称
    归属逻辑数据源:批量登记的数据源选择归属逻辑数据源时,请勿选择已添加一个生产数据源和一个测试数据源的逻辑数据源。否则可能会导致引用该逻辑数据源的线上任务执行失败。
  • 负责人:默认为当前创建人员
  • 管理员:同负责人,有该数据源的管理权限,包括编辑、设置“源系统账号映射”。可在安全中心为自己或其他人设置该数据源的使用权限
  • 使用授权:可选项目组内所有项目,也可指定项目授权
  • URL:支持host域名或者IP:Port格式。支持http://https://
  • 自定义参数:自定义参数支持key-value的格式,用于静态数据
说明: 此处的参数引用时,使用$(XXX)格式进行引用。
唯一性校验规则:基于URL进行校验。

支持配置通过其它接口获取参数值,数据传输在调用API前,实时处理这个参数接口。需要注意的是,此处接口host同上述登记host,且不支持跨域获取接口参数。

API数据源登记 - 图2

  • 参数名称:必填,即变量名称
  • 请求方式:必填,支持POSTGET
  • Headers:请求中的Head参数
  • Body/Params:当请求类型为POST时,此处为Body,即参数放在请求体内;当请求类型为GET时,此处为Params,即参数一般直接跟在url后面
  • 截取内容:必填,即变量值,指的是请求返回的数据中需要返回的值。支持两种表达方式,a. 用.逐层获取json内的值; b. 用JSONPath获取json内的值

关于截取内容的方式:

  • 方式一:用“.”分隔变量。如果要返回下方“传输name”这个值,表达式为data.name。

    {
    "id":"1",
    "name":"传输",
    "data":{
         "name":"传输name"
         }
    }
  • 方式二:JSONPath表达式。方式一适用于大多数场景,但是由于只能逐层获取String,对于特殊场景需要使用方式二,即JSONPath表达式。如果要返回下方dataArr[0]这个对象,则在表达式$.dataArrr.[0]前加上前缀JSONPath,即JSONPath:$.dataArrr.[0]。如果要返回name=“arr1”,则表达式为JSONPath:$.dataArr.[0].name

    {
    "id":"1",
    "name":"传输",
    "data":{
         "name":"传输name"
         },
    "dataArr":[
         {
         "id":1,
         "name":"arr1"
         },
         {
         "id":2,
         "name":"arr2"
         }
    ]
    }