接口开发

您可以参考本文完成组件接口的开发和使用。

整个过程主要分为三步:

  1. 获取业务组件数据结构。

    业务组件的数据结构和该组件的 mock.json 文件除去可选参数字段外,其余字段均保持一致。

  2. 编写接口。

    • 表单提交接口

      修改组件后,会调用该接口保存组件的最新数据。

      {
        apiData:'{ // 组件的数据(jsonString)
          "title":"标题",
          ...
          "params": "{"id":"0"}", // params 代表该提交接口所需要的额外的参数
        }',
        pageId: 134, // 页面id
        componentId: "3bb79d72-52f6-4fe8-b07a-95e3ae193c0c" // 组件在编辑器中生成在画布中的唯一标识
      }
    • 数据源接口

      获取组件的最新数据。

      // 参数
      {
        pageId: 134,
        componentId:"3bb79d72-52f6-4fe8-b07a-95e3ae193c0c",
        apiData: '{
          "params":"{"id":"0"}", // 额外的参数
        }'
      }
      
      //返回值
        apiData: '{ // 组件数据(jsonString)
          "title": "标题",
          ...
          "params": "{"id":"0"}" , 
        }',
        pageId: 134,
        componentId:"3bb79d72-52f6-4fe8-b07a-95e3ae193c0c"
  3. 录入接口。

    在智能搭建控制台的 接口管理 模块中,创建接口,录入已编写的接口,并指定该接口适用的组件。更多内容,参见 创建接口。接口创建完毕后,需要对接口和所适用的组件进行校验。接口校验通过后,您才能在页面搭建编辑器中看到和使用该接口。