通过向导模式创建API(Dataphin表)

向导模式基于Dataphin逻辑表,通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。

前提条件

MaxCompute计算引擎下支持逻辑表创建API,需完成以下步骤:

  • 基于逻辑表生成API的场景中,需要完成逻辑表(维度逻辑表、事实逻辑表和汇总逻辑表)的创建。具体操作,请参见规范建模概述

  • 基于创建好的逻辑表,在集成中配置同步任务,具体步骤如下:

    • 运维 > 周期任务中选中逻辑表对应任务,选择补数据 > 补当前及下游任务,任务列表选择6层,全选任务列表,并在补数据实例查看是否运行成功。具体操作请参见周期任务补数据

    • 即席查询中查看数据是否符合预期,确保逻辑表中有数据。具体操作请参见查询并下载数据

    • 在集成中配置同步任务,输入组件选择逻辑表输入配置(LogicalTable),输出组件选择MySQL输出组件,具体操作请参见配置LogicalTable输入组件配置MySQL输出组件

      配置完同步任务后,且成功发布后,可在数据服务创建逻辑表API并进行提交/发布。

使用限制

支持服务项目管理员开发用户角色的账号生成API。

注意事项

API的请求参数和返回参数需从同一个逻辑表中获取,否则后续无法正常调用该API。

步骤一:选择生成API的方式

  1. 在Dataphin首页,选择服务 > 开发

  2. 选择项目,单击左侧导航栏API,在API页面,单击+新建API

  3. API创建方式选择对话框,选择逻辑表API-向导模式(Dataphin表)后,单击确定

步骤二:配置API参数信息

  1. 新建API页面,配置API基本信息和参数配置。

    API基本信息配置

    参数

    描述

    API名称

    填写API的名称。命名规则如下:

    • 只能包含汉字、字母、数字或下划线(_)。

    • 长度为4~42个字符。

    • 以字母开头。

    • 全局唯一。

    请求方式

    API请求方式包括GET和LIST:

    • GET:请求服务器获取指定的某个资源。

    • LIST:请求服务器获取某一部分的资源。

    数据更新频率

    定义API返回数据的更新频率,选择每天每小时每分钟更新API返回的数据,便于调用方了解数据的时效性。

    API分组

    选择当前项目下配置的API分组,如需创建,请参见创建服务分组

    描述

    填写对API的简单描述。不超过128个字符。

    协议

    当前,数据服务支持生成API接口协议包括HTTP和HTTPS。

    • HTTP:即超文本传输协议HTTP(HyperText Transfer Protocol),是应用最为广泛的网络协议。

    • HTTPS:即HTTP的安全版。HTTPS的安全基础是SSL,因此您需要配置独立域名的SSL证书。同时需确保独立域名的SSL证书有效,避免无法正常调用。

    时时

    超时时间用于监控API调用的时长。调用API过程中如果超过了设定的超时时间,则调用API时会报错,便于您及时发现并处理调用API的异常情况。异常情况查看,详情请参见查看及管理运维监控API

    缓存设置

    支持开启关闭。开启后需配置缓存时长

    版本号

    请填写API的版本号,每份配置信息会有所属版本号,以便于和上个版本信息对比。64字符以内。该API下版本号唯一。

    返回类型

    默认JSON。

    API请求参数和返回参数配置

    在配置API请求参数返回参数过程中,您需要先确定API的入参和出参的来源(逻辑表),再将入参和出参分别添加至请求参数返回参数区域,最后配置请求参数返回参数的基本信息。

    1. 参数配置面板,选择了模式Dataphin逻辑表后,页面下方会为您展示已选择的Dataphin逻辑表中所有的字段。

      image.png

      参数

      描述

      模式

      支持BasicDev_Prod两种模式。

      • Basic模式下开发时、提交及发布线上均读取生产库。

      • Dev-Prod模式下开发及提交读取开发库,发布线上读取生产库。

      逻辑表字段

      需选择该逻辑表所在的业务板块及选中的板块下的逻辑表。支持复制全表字段或单个字段。

    2. 在双列表框的左侧列表中选择一个或多个字段后,单击image图标,将已选择API的字段添加至右侧的请求参数列中,再配置请求参数的基本信息。

      image.png

      参数

      描述

      参数名

      对外开放的参数,即用户访问API时直接使用的参数。命名规则如下:

      • 包含字母、数字或下划线(_)。

      • 以字母开头。

      • 长度为1~64字符。

      绑定字段

      对外不可见的参数,API调用时实际访问的参数。

      参数类型

      参数类型包括Double、Float、String、Date、Boolean、Int、Long、Short、Byte、Bigdecimal、Binary。您需要根据逻辑表中字段的类型选择对应的参数类型。

      如果逻辑表的字段类型不在待选参数类型范围内,推荐您选择String。

      操作符

      调用API时对请求参数的处理方式。当前支持的操作符及含义请参见附录:支持的操作符

      示例

      填写请求参数值的示例,便于开发者理解。例如:参数名称为ID,参数类型为Int,操作符为=,则示例处可以配置为5。

      描述

      填写对请求参数的简单描述。

      是否必填

      请求参数是否为调用API时的必填参数。

      • 选择为:调用API的语句中没有该参数也可以执行调用API的SQL语句。

      • 选择为:调用API的语句中没有该参数无法执行调用API的SQL语句。

      例如,请求参数为id,请求参数为必填参数,返回参数为name;则执行以下语句会有不同的返回:

      • select name from tableA,where id=5;:则返回对应的name字段及数据。

      • select name from tableA;:则SQL语句执行报错。

    3. 在双列表框的左侧列表中选择一个或多个字段后,单击image图标,将已选择API的字段添加至右侧的返回参数列中,再配置返回参数的基本信息。

      image.png

      参数

      描述

      参数名

      对外开放的参数,API返回时最终展示给用户的参数名称。命名规则如下:

      • 包含字母、数字或下划线(_)。

      • 以字母开头。

      • 长度为1~64字符。

      绑定字段

      对外不可见的参数,API调用时实际访问的参数。

      参数类型

      调用API时的数据格式。参数类型包括Double、Float、String、Date、Boolean、Int、Long、Short、Byte、Bigdecimal、Binary。您需要根据逻辑表中字段的类型选择对应的参数类型。

      如果逻辑表的字段类型不在待选参数类型范围内,推荐您选择String。

      示例

      填写返回参数值的示例,便于开发者理解。

      描述

      填写对返回参数的简单描述。

  2. 单击提交,即可完成API的生成。

附录:支持的操作符

操作符

描述

=

检查两个操作数的值是否相等,如果相等则条件为真。

>

检查左操作数的值是否大于右操作数的值,如果是则条件为真。

>=

检查左操作数的值是否大于等于右操作数的值,如果是则条件为真。

<

检查左操作数的值是否小于右操作数的值,如果是则条件为真。

<=

检查左操作数的值是否小于等于右操作数的值,如果是则条件为真。

!=

检查左操作数的值是否不等于右操作数的值,如果是则条件为真。

in

运算符用于把某个值与一系列指定列表的值进行比较。

like

like包括%like%、%like、like%:

  • %like%:表示忽略前后缀,进行字符匹配。

  • %like:表示忽略前缀,进行字符匹配。

  • like%:表示忽略后缀,进行字符匹配。

后续步骤

  • 生成API后,需要对API进行测试并发布至数据服务市场,便于后续应用可以调用API。具体操作,请参见测试与发布API

  • 若需要对API进行删除、版本管理、转让负责人等操作,请参见查看及管理API