本文为您介绍如何在向导模式和SQL模式下新建API。

模板向导模式新建API

  1. 登录Dataphin
  2. 在顶部导航栏,选择服务 > 个人后台 > API, 进入API页面。
  3. 在API页面,单击页面右上角的新建API新建API
  4. 选择模板向导模式,单击下一步API向导模式
    • 模板向导模式:通过界面化配置服务单元字段及相应查询条件生成API,操作简单。
    • 自定义SQL模式:通过脚本模式配置服务单元字段,支持使用复杂查询条件及简单函数生成API。
  5. 配置API基础信息。配置API名称请求方式数据更新频率描述,然后单击下一步向导-配置API基础信息
    • API名称:中英文开头,由汉字、英文、数字或下划线组合组成。
    • 请求方法:包括GETLIST
    • 数据更新频率:包括每天每小时每分钟
    • 描述:对创建的API进行简单的描述。
  6. 根据页面提示完成配置参数。
    编号 参数 说明
    1 服务单元分组配置 单击,选择您已有的服务单元分组。
    2 单击,选择您已有的服务单元类型。
    3 单击,选择您已有的服务单元。
    4 服务单元字段 选择服务单元资源。
    完成1,2,3,4处的参数配置后,单击5处的,将字段信息同步到右侧的请求参数,单击6处的,将字段信息同步到右侧的返回参数。根据页面提示配置参数名参数类型操作符示例描述是否必填
  7. 单击确定并在预发环境发布,完成预发环境发布。

    如果新建的API不需在预发环境发布,您可以通过单击更新保存新建API。

自定义SQL模式新建API

  1. 在API页面,单击右上角的新建API新建API
  2. 选择自定义SQL模式,单击下一步自定义SQL向导模式
    • 模板向导模式:通过界面化配置服务单元字段及相应查询条件生成API,操作简单。
    • 自定义SQL模式:通过脚本模式配置服务单元字段,支持使用复杂查询条件及简单函数生成API。
  3. 根据页面提示完成参数配置,并单击下一步向导-配置API基础信息
    • API名称:中英文开头,由汉字、英文、数字或下划线组合组成。
    • 请求方法:包括GETLIST
    • 数据更新频率:包括每天每小时每分钟
    • 描述:对创建的API进行简单的描述。
  4. 解析参数。输入查询SQL并单击解析参数,校验SQL并获取参数内容,左方服务单元字段参考,可通过选取服务单元快速获得服务单元字段信息。解析参数
    注意 此处输入SQL脚本限制如下:
    • 仅支持一条SQL语句,不支持多条SQL语句。
    • 支持SELECT,不支持非SELECT语法,如INSERT、UPDATE、DELETE等。
    • 不支持多表关联查询,嵌套查询。
  5. 解析参数成功后,按需填写请求参数的示例、描述以及返回参数的示例、描述等信息。参数配置

    请求参数:根据页面提示配置参数名参数类型示例描述是否必填

    返回参数:根据页面提示配置参数名参数类型示例描述

  6. 单击确定并在预发环境发布,完成预发环境发布。

    如果新建的API不需在预发环境发布,您可以通过单击更新保存新建API。