本文为您介绍如何注册API并对其进行配置。

注册API

  1. 进入数据服务页面。
    1. 登录DataWorks控制台
    2. 在左侧导航栏,单击工作空间列表
    3. 选择工作空间所在地域后,单击相应工作空间后的进入数据服务
  2. 服务开发页面,鼠标悬停至新建图标,单击注册API
    您也可以在API列表中,右键单击存放API的分组名称,选择注册API
  3. 注册API对话框中,配置各项参数。
    注册API
    参数 描述
    API名称 支持中文、英文、数字、下划线(_),且只能以英文或中文开头,4~50个字符。
    API分组 API分组是指针对某一个功能或场景的API集合,也是API网关对API的最小管理单元。在阿里云API市场中,一个API分组对应于一个API商品。

    您可以悬停鼠标至新建图标,单击新建分组进行新建。

    API Path API存放的路径。支持英文、数字、下划线(_)、连字符(-),且只能以斜线(/)开头,不得超过200个字符。例如/user
    协议 支持HTTPHTTPS协议。

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

    请求方式 支持GETPOSTPUTDELETE
    返回类型 支持JSONXML
    可见范围 包括工作空间私有
    • 工作空间:该API对本工作空间内的所有成员可见。
    • 私有:该API仅对API的负责人可见,且暂不支持授权。
      说明 如果设置可见范围为私有,在目录树中,仅自己可见,工作空间内的其他成员不可见。
    标签 标签列表中选择相应的标签。详情请参见管理API标签
    描述 对API进行简要描述,不得超过2000个字符。
  4. 单击确认

配置API

  1. 在注册API编辑页面的后端服务定义区域,配置各项参数。
    后端服务定义
    参数 描述
    后台服务Host 待注册API服务的Host,以http://https://开头,并且不包含Path。
    后台服务Path 待注册API服务的Path,Path中支持参数,参数要放在[]中,如/user/[userid]

    配置Path中的参数后,在注册API向导的第二步API参数配置环节,系统会自动在请求参数列表添加Path位置的参数。

    后端超时 设置后端超时时间。
  2. 请求参数定义区域,配置各项参数。
    请求参数定义
    参数 描述
    请求参数 您可以单击新增参数,根据页面配置API的请求参数。

    其中参数位置支持QUERYHEADBODY。不同的请求方式支持不同的参数位置,请根据页面提供的可选项按需选择。

    常量参数 参数值为固定的参数,对调用者不可见。调用API时无需传入常量参数,但后台服务始终接收您在此处配置的常量参数及参数值。

    适用于固定某个参数的取值并对调用者隐藏参数的场景。

    请求Body定义 仅请求方式为POSTPUT时,会出现该参数。

    请求Body定义支持输入JSON和XML类型的Body描述,相当于一个请求Body的示例,以供API调用者参考格式。

  3. 返回内容定义区域,输入正常返回结果示例异常返回结果示例,以便API调用者参考和编写API返回结果解析代码。
  4. 错误码定义区域,填写调用API时出现的错误码错误信息解决方案,以便API调用者参考并自行查找错误原因。
  5. 单击工具栏中的保存图标。
    配置API后,您可以对其进行测试。详情请参见测试API

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