统一接口

统一接口是什么?

在实际的应用页面中肯定会有一个这样的需求,比如一个接口要一次性全部取出当前页面所有的数据,但是因为在IDM中每个组件都是独立的,所以才有了统一接口这个功能,搭配组件通信就能实现一个接口的返回数据能应用到多个组件中。

上面的这个例子可能不明显,那我们再来举个例子,比如表单的整个数据回显,编辑状态的时候要把整个表单数据取出来,我们不可能一项一项去获取,所以统一接口在这里就用处非常明显。

接口配置

当我们写好了后端接口或者已有接口可直接使用的话,不需要再单独开发前端代码去请求,只需要通过页面属性-页面接口进行相应的配置即可

使用方法

  • 配置接口

    使用页面属性的页面接口新增一条空数据,然后根据接口来配置对应的属性。最后设置结果集名称,只需要保证结果集在当前应用页面的所有接口为唯一即可。

  • 定义方法

    组件内直接定义setContextValue方法

    setContextValue(object) {
    }
    

    object参数格式:

    {
      "type":"定义的类型,已知类型:pageCommonInterface(页面统一接口返回值)",
      "key":"数据key标识,页面每个接口设置的数据集名称,方便识别获取自己需要的数据",
      "data":"数据集,内容为任意格式"
    }
    

    提示

    组件方法的详细使用说明请参考:内置方法-setContextValue