预发环境的API测试成功后才能发布到API服务(API市场)中。本文为您介绍如何测试API。

前提条件

请参见模板向导模式新建API自定义SQL模式新建API,完成API的创建。

背景信息

  • API测试只针对预发布环境的API测试,建议您完成API的测试后再发布API。
  • 测试API的权限限制,详情请参见数据服务权限列表

操作步骤

  1. 使用开发用户或超级管理员角色的账号,登录Dataphin控制台
  2. 在Dataphin控制台页面,选择工作区地域后,单击进入Dataphin>>
    您可以单击快速开始相关工作区域的数据服务,快速进入数据服务模块。
    说明 如果您通过快速开始相关工作进入数据服务模块,则跳过步骤3。
  3. 在Dataphin首页,单击服务,进入数据服务页面。
  4. 进入API页面。
    1. 在在API服务页面,单击顶部菜单栏的个人后台
    2. 个人后台页面,单击左侧导航栏开发中心下的API
  5. API页面,鼠标悬停至需要测试的APIgaga图标后,单击测试
    快速查询需要测试的API:
    • 选择服务单元服务单元分组,筛选API。
    • 在输入框中,输入API名称关键字,搜索API。
  6. API测试页面,填写业务请求参数列表公共请求参数列表区域的测试输入值,在可选返回参数列表区域选择返回参数。
  7. 单击测试
  8. 测试详情区域,查看测试结果。
    您也可以单击API测试页面下方的查看错误代码表,查看API错误代码。