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

前提条件

操作步骤

  1. 使用开发用户或超级管理员角色的账号,登录Dataphin控制台
  2. 在Dataphin控制台页面,选择工作区地域后,单击进入Dataphin>>
  3. 进入API页面。
    1. 在Dataphin首页,单击服务,进入数据服务页面。
    2. 在顶部菜单栏,单击个人后台
    3. 在左侧导航栏,单击开发中心下的API
  4. 单击页面右上角的新建API
  5. 选择API创建方式。
    1. 根据API创建方式选择页面提示,选择模板向导模式
    2. 单击下一步
  6. 配置API基础信息。
    1. 根据API基础信息配置页面提示,配置参数。
      gaga
      参数 描述
      API名称 填写API名称。API名称由汉字、英文、数字或下划线组合组成。
      请求方式 选择API的请求方式。请求方式包括:
      • GET
      • LIST
      数据更新频率 选择通过API同步数据的频率。数据更新频率包括:
      • 每天
      • 每小时
      • 每分钟
      描述 填写对API简单的描述。
      协议 选择通过API同步数据的协议。协议包括:
      • HTTP
      • HTTPS
    2. 完成参数配置后,单击下一步
  7. 配置参数。
    1. 根据参数配置页面提示,配置参数。
      编号 参数 描述
      服务单元分组配置 单击图标,选择您已有的服务单元分组。
      单击图标,选择您已有的服务单元类型。
      单击图标,选择您已有的服务单元。
      服务单元字段 选择服务单元资源。
      完成1、2、3、4处的参数配置后,单击图标,将字段信息同步到右侧的请求参数后,根据页面提示配置参数名参数类型操作符示例描述是否必填
      完成1、2、3、4处的参数配置后,单击图标,将字段信息同步到右侧的返回参数后,根据页面提示配置参数名参数类型操作符示例描述是否必填
      数据预览 单击数据预览,可以预览服务单元的数据。
    2. 单击确定并在预发环境发布,完成API在预发环境的发布。