系统支持通过界面化配置服务单元字段及查询条件生成API,本文为您介绍如何通过模板向导模式新建API。

前提条件

背景信息

通过模板向导模式新建API的权限限制,详情请参见数据服务权限列表

操作步骤

  1. 使用开发用户或超级管理员角色的账号,登录Dataphin控制台
  2. 在Dataphin控制台页面,选择工作区地域后,单击进入Dataphin>>
    您可以单击快速开始相关工作区域的数据服务,快速进入数据服务模块。
    说明 如果您通过快速开始相关工作进入数据服务模块,则跳过步骤3。
  3. 在Dataphin首页,单击服务
  4. 在数据服务页面,单击顶部菜单栏的个人后台
  5. 个人后台页面,单击左侧导航栏开发中心下的API
  6. API页面,单击新建API
  7. 选择API创建方式。
    1. API创建方式选择页面,选择模板向导模式
    2. 单击下一步
  8. 配置API基础信息。
    1. API基础信息配置页面,配置参数。
      gaga
      参数 描述
      API名称 填写API名称。API名称由汉字、英文、数字或下划线(_)组合组成。API名称的限制如下:
      • API名称的长度范围为4~42个字符。
      • API名称仅支持以英文字母开头。
      • 系统内API名称不允许重复。
      请求方式 选择API的请求方式。
      数据更新频率 选择API同步数据的频率。
      描述 填写简单描述。
      协议 选择API同步数据的协议。
      注意 完成SSL证书的配置,避免无法正常调用。
    2. 单击下一步
  9. 配置参数。
    1. 参数配置页面,配置参数。
      test
      区域 参数 描述
      参数配置 服务单元分组配置 依次选择服务单元分组、服务单元类型和服务单元。
      服务单元字段 为您展示该服务单元的字段。您也可以单击数据预览,查看服务单元字段。
      请求参数

      选中服务单元字段区域的字段后,单击上方的图标,同步字段信息至右侧的请求参数区域。

      选中请求参数区域的字段后,单击下方的test图标,删除请求参数区域的参数。

      参数名 参数名由字母、数字或下划线(_)组合组成。
      说明 参数名不能超过64个字符。
      参数类型 选择参数的类型。
      操作符 选择参数的操作符。
      示例 填写参数示例。
      说明 示例不能超过20个字符。
      描述 填写参数的描述。
      说明 描述不能超过50个字符。
      是否必填 选择参数是否为必填参数。
      返回参数

      选中服务单元字段区域的字段后,单击下方的图标,同步字段信息至右侧的返回参数区域。

      选中返回参数区域的字段后,单击下方的test图标,删除返回参数区域的参数。

      参数名 参数名由字母、数字或下划线(_)组合组成。
      说明 参数名不能超过64个字符。
      参数类型 选择参数的类型。
      操作符 选择参数的操作符。
      示例 填写参数示例。
      说明 示例不能超过20个字符。
      描述 填写参数的描述。
      说明 描述不能超过50个字符。
    2. 单击确定并在预发环境发布,完成API在预发环境的发布。