本文为您介绍如何进行修改、测试、发布、下线、删除API操作。

模板向导模式下修改API

  1. 登录Dataphin。
  2. 在Dataphin首页,选择服务 > 个人后台 > API,进入API。
  3. 选择需要修改的API,单击其后的图标,进入编辑API页面。
  4. 修改API基础信息。仅可修改API的描述数据更新频率API名称请求方法均不可以修改。修改完成后,单击下一步修改向导模式API
  5. 根据页面提示修改配置参数,详细内容请参见新建API修改配置参数
  6. 单击确定并在预发环境发布,完成预发环境发布的更新。

    如果修改的API暂时不需在预发环境发布,您也可以单击更新保存修改。

说明 仅限API负责人和超级管理员可进行修改操作。

自定义SQL模式下修改API

  1. 单击API列表中操作列下的,进入编辑API页面。
  2. 修改API基础信息。仅可修改API的描述数据更新频率API名称请求方法均不可以修改。修改完成后,单击下一步修改向导模式API
  3. 编辑API页面,可编辑API SQL脚本编辑请求参数返回参数参数,详细内容请参见自定义SQL模式新建API
  4. 单击确定并在预发环境发布,完成预发环境发布的更新。

    如果修改的API暂时不需在预发环境发布,您可以单击更新保存修改。

说明 仅限API负责人和超级管理员可进行修改操作。

测试API

  1. 选择已成功在预发环境发布的API,单击操作列下的后,单击测试,进入API测试页面。测试API
  2. API测试页面中,根据示例填写 业务请求参数列表中的 测试输入值,根据示例填写 公共请求参数列表中的 测试输入值以及选择 可选返回参数列表
  3. 单击测试按钮,查看API响应时间以及测试详情。测试
  4. 单击错误代码表按钮,可查看错误代码表。查看错误代码
说明 API测试只针对预发布环境的API测试,建议您进行测试之后再进行API正式发布。

发布API

在API列表中选中已预发的API,单击操作列下的后,并单击发布,完成API在生产环境中发布。发布API

下线API

  1. 在任意一个已经上线的API列表中,单击操作列下的后,并单击下线下线API
  2. 在弹出的对话框中单击确定,完成下线API操作。
说明 仅API管理员及超级管理员可进行下线操作。

删除API

  1. 在任意一个已经上线的API列表中,单击操作列下的后,并单击删除
  2. 在弹出的对话框中单击确定,完成删除API操作。删除API
说明 仅API管理员及超级管理员可进行删除操作。

转让API管理员

  1. 在API列表中操作列下的转让图标。
  2. 在弹出的对话框中,选择被转让的成员。转让
  3. 单击提交,完成管理员转让。
说明 仅限API管理员及超级管理员可进行转交API管理员。