您无需编写任何代码,在界面勾选配置即可快速生成API。本文为您介绍如何通过向导模式生成API。

前提条件

配置API前,请先在工作空间管理 > 数据源管理页面配置数据源。详情请参见配置数据源

生成API

  1. 进入数据服务页面。
    1. 登录DataWorks控制台
    2. 在左侧导航栏,单击工作空间列表
    3. 选择工作空间所在地域后,单击相应工作空间后的进入数据服务
  2. 服务开发页面,鼠标悬停至新建图标,单击API > 生成API
    您也可以打开相应的业务流程,右键单击API,选择新建 > 生成API
  3. 生成API对话框中,配置各项参数。
    向导
    参数 描述
    API模式 包括向导模式脚本模式,此处选择向导模式
    API名称 支持中文、英文、数字、下划线(_),且只能以英文或中文开头,4~50个字符。
    API Path API存放的路径,例如/user
    说明 支持英文、数字、下划线(_)和连字符(-),且只能以( /) 开头,不得超过200个字符。
    协议 支持HTTPHTTPS

    如果您需要通过HTTPS协议调用API,请您发布API至网关后,在API网关控制台绑定独立域名,并上传SSL证书。详情请参见支持HTTPS

    请求方式 支持GETPOST
    返回类型 仅支持JSON返回类型。
    可见范围 包括工作空间私有
    • 工作空间:该API对本工作空间内的所有成员可见。
    • 私有:该API仅对API的负责人可见,且暂不支持授权。
      说明 如果设置可见范围为私有,在目录树中,仅自己可见,工作空间内的其他成员不可见。
    标签 标签列表中选择相应的标签,详情请参见管理API标签
    说明 标签名称支持汉字、英文、数字和下划线(_),您最多可以设置5个标签,且每个标签不超过20个字符。
    描述 对API进行简要描述,不得超过2000个字符。
    目标文件夹 存放API的目录。
  4. 单击确认

配置API

  1. 双击打开API的编辑页面,在选择表区域,选择数据源类型数据源名称数据表名称
    选择表
    说明
    • 您需要提前在数据集成中配置好数据源,数据表下拉列表支持表名搜索。
    • 创建好API后,会自动跳转至数据表配置页面,您可以直接进行配置。
  2. 环境配置区域,设置内存超时时间
    环境配置
  3. 选择参数区域,设置请求参数和返回参数。
    您选择数据表后,选择参数区域会自动显示该表的所有字段。根据自身需求,分别选中相应的字段设为请求参数设为返回参数,添加至请求参数和返回参数列表中。选择参数
    如果您需要对字段进行排序,单击相应字段后的添加到字段排序,将其添加至排序字段列表中。排序

    您可以根据数据表中的指定字段对API的返回结果进行排序。当您的排序列表中有多个字段时,序号越小的字段,排序的优先级越高,您可以通过上移下移操作来调整排序字段的优先级。对于每个排序字段,您均可以选择升序降序的方式进行排序。

  4. 单击API编辑页面右侧的请求参数,配置各项参数。
    请求参数
    参数 描述
    参数名称 请求参数的名称,支持英文、数字、下划线、连字符(-),且仅支持以英文开头,不能超过64个字符。
    绑定字段 默认不可以修改。
    参数类型 包括STRINGINTLONGFLOATDOUBLEBOOLEAN
    操作符 操作符用于表示请求参数和实际赋值之间的关联和比较。您可以选择以下操作符:
    • 等于:请求参数等于实际赋值。
    • LIKE:为请求参数搜索某种指定模式。
    • IN:为请求参数规定赋值集合。
    • NOT IN:请求参数不在赋值集合中。
    • NOT LIKE:请求参数不在该指定模式中。
    • !=:请求参数不等于实际赋值。
    • >:请求参数大于实际赋值。
    • <:请求参数小于实际赋值。
    • >=:请求参数大于或等于实际赋值。
    • <=:请求参数小于或等于实际赋值。
    是否必填 该请求参数是否必填。
    示例值 该请求参数的示例值。
    默认值 该请求参数的默认值。
    描述 该请求参数的简要说明。
    如果您需要对API的请求参数进行预处理,请选中高级配置区域的使用前置过滤器。详情请参见创建和使用前置过滤器
    说明
    • 仅华东2(上海)地域的DataWorks专业版及以上版本支持使用前置过滤器。
    • 尽量设置有索引的字段为请求参数。
    • 为方便API调用者了解API详情,请尽量设置API参数的示例值、默认值、描述等信息。
  5. 单击API编辑页面右侧的返回参数,配置各项参数。
    返回参数
    参数 描述
    参数名称 返回参数的名称,支持英文、数字、下划线、连字符(-),且仅支持以英文开头,不能超过64个字符。
    绑定字段 默认不可以修改。
    参数类型 包括STRINGINTLONGFLOATDOUBLEBOOLEAN
    示例值 该返回参数的示例值。
    描述 该返回参数的简要说明。

    您还可以在高级配置区域,设置是否返回结果分页使用过滤器

    返回结果分页的说明如下:
    • 如果不开启返回结果分页,则API默认最多返回2000条记录。
    • 如果返回结果可能超过2000条,请开启返回结果分页功能。
    开启返回结果分页后,会自动增加以下公共参数:
    • 公共请求参数
      • pageNum:当前页号。
      • pageSize:页面大小,即每页记录数。
    • 公共返回参数
      • pageNum:当前页号。
      • pageSize:页面大小,即每页记录数。
      • totalNum:总记录数。
    如果您需要对API的查询结果进行二次处理,请选中使用过滤器。详情请参见创建和使用后置过滤器
    说明
    • 仅华东2(上海)地域的DataWorks专业版及以上版本支持使用后置过滤器。
    • API允许不设置请求参数,当无请求参数时,必须开启返回结果分页
  6. 单击工具栏中的保存图标。
    配置API后,您可以对其进行测试。详情请参见测试API

    测试成功后,请关闭API测试对话框,单击右上方的发布

    您还可以在服务开发页面,展开API列表,查看已发布API的详情,并进行克隆和删除等操作。详情请参见管理API

转换向导模式为脚本模式

您可以转换向导模式生成的API为脚本模式:

  1. 服务开发页面,展开目标API所在的业务流程 > API
  2. 双击相应的API名称,打开该API的编辑页面。
  3. 单击工具栏中的转换脚本图标。
  4. 提示对话框中,单击确认,您可以在编写查询SQL区域,查看转换后的SQL语句。
    注意
    • 数据服务仅支持转换向导模式配置的API为脚本模式。
    • 向导模式转换为脚本模式后,无法回退至向导模式。