测试与发布API

前提条件

在开始执行操作前，请确认您已完成API的创建。更多信息，请参见创建API。

API调用/测试直连模式和代理模式说明

数据服务支持直连模式和代理模式调用API，若API关联了行级权限，则根据调用模式确认鉴权方式。

• 直连模式：在行级权限中申请数据服务应用的行级权限，使用应用进行鉴权。

• 代理模式：若应用需代理用户的行级权限调用API，需在行级权限中申请数据服务应用的行级权限，再为应用申请API的代理权限，即可代理用户调用API。

API测试页面顶部区域操作

• 查看域名：在页面顶部可以查看域名，该域名仅用于内部测试，用于客户端调用的域名，请参见查看域名。

• 切换API：支持在页面左上角切换查看已提交或已发布的API。支持根据API的名称或ID模糊搜索API，搜索当前服务项目下有权限的API进行切换，系统将为您推荐您在当前项目下访问过（包括查看、编辑、测试、新增）的最近9条API。

• 切换API运行环境：支持切换API运行环境进行API测试。当运行环境为开发环境时，使用开发数据源进行测试；当运行环境为生产环境时，使用生产数据源进行测试。如果API未发布，则无法切换为生产环境进行测试。

  说明

  若API为Basic模式，且运行环境为开发环境时，测试API时会使用生产数据源进行测试。

• 切换API版本：支持在测试页面的右上角切换版本进行测试。当运行环境为开发环境，支持选择已提交的版本；当运行环境为生产环境，支持选择已发布的版本。

步骤一：测试API

1. 在Dataphin首页的顶部菜单栏，选择服务 > 开发。

2. 在左上角选择服务项目，在左侧导航栏选择API服务 > API，进入API页面。

   • 在API页面单击目标API操作列下的测试图标，进入API测试页面。

   • 在API页面单击目标API操作列下的更多-版本管理，进入版本管理面板，再单击目标API操作列下的测试，进入API测试页面。

3. 在API测试页面，您可以输入参数值来验证返回参数是否符合预期。

   1. 配置业务请求参数列表区域的测试输入值为业务数据中的字段值。

      业务请求参数列表区域展示的参数是您创建API时配置的请求参数。

   2. 配置公共请求参数列表区域的参数。

      • 当API类型为直连数据源API或服务单元API时，系统根据API不同的请求方式，展示不同的参数（PageStart、PageSize和OrderByList）。

        • 开启分页查询，若API请求方式为LIST，展示PageStart、PageSize和OrderByList参数；若API请求方式为GET，展示OrderByList参数。

        • 关闭分页查询，若API请求方式为LIST，展示OrderByList参数，您可以取消选中隐藏参数，展示PageSize和OrderByList参数。

      • 当API类型为直连数据源API、服务单元API或组合API且关联行级权限开启时，展示AccountType、DelegationUid参数。

        参数	描述	调试输入值
        AccountType	当使用代理模式认证时，需要指定代理用户的账号类型。 ACCOUNT_NAME：Dataphin的用户名。 USER_ID: Dataphin内部的唯一ID。 SOURCE_USER_ID：源系统账号ID。 说明 仅当设置了DelegationUid时，需要配置此参数。若未填写此参数，则默认类型为USER_ID。	选择指定代理用户的账号类型，支持选择ACCOUNT_NAME、USER_ID、SOURCE_USER_ID。
        DelegationUid	被代理访问的用户，需根据所选AccountType的类型，传入对应账号ID。设置该参数后，使用代理模式的认证方式。	仅支持当前租户账号作为DelegationUid。
        apiVersion	用于指定调用API的版本，默认使用最新版本。	调试输入值从页面右上角切换版本获取。 说明 当运行环境为开发环境，支持apiVersion参数，仅可选择已提交的API进行调用。
        PageStart	用于定义返回数据从第几条开始展示。	配置成正整数，例如2。
        PageSize	用于定义每页返回多少数据。	配置成正整数，例如56。
        OrderByList	用于定义多个返回参数的排序方式。如果没有填写，则默认为升序排列。	调试输入值需要从业务请求参数列表中获取。

   3. 当API类型为直连数据源API、服务单元API或组合API且关联行级权限开启时，在行级权限列表区域展示当前API版本及环境对应的所关联的已开启的行级权限信息，包括行级权限名称、描述说明。

   4. 在可选返回参数列表区域选择返回参数。返回参数的列表为已选择的API版本对应的API返回参数。您需要选择至少一个返回参数才能测试API。

   5. 配置API的协议和返回条数。

      参数	描述
      协议	如果您创建API时选择协议是HTTP和HTTPS，则调试API时可以选择协议。
      返回条数	用于定义测试API时返回数据的条数： 如果请求方式为LIST，则支持选择返回条数，最大可返回10000条数据。 请求方式为GET，不支持修改返回条数。

4. 配置完成后，单击返回条数后的调试/测试，进行API与数据源数据的连通性测试。

   • API测试时，支持单击查看脚本，查看SQL的脚本，方便对比查询结果是否符合脚本处理预期。若注册API无SQL脚本，则不支持查看。

     说明

     • 调用组合API时，若组合API引用的API有行级权限管控，需将AccountType和DelegationUid参数传入到引用的API。

     • 使用代理模式调用组合API，仅需申请组合API的代理权限即可。

   • 若API调用模式为异步模式，API测试/调试后，查询结果将在测试结果区域展示，您可以在测试结果中查看您的运行结果、日志、代码等信息，异步查询的流程请参见异步调用流程说明。

     • 查看请求结果：单击调用API页签，再单击返回结果页签，可查看调用API的Body返回的请求结果。

     • 脚本代码：单击调用API页签，再单击脚本代码页签，可查看编写的SQL语句。

     • 查看日志：单击获取查询状态页签，查看API调用时的执行日志。如需取消API测试/调试，可单击取消查询，取消查询请求。

     • 查看查询结果：单击获取查询结果页签，可查看调用API的Body返回的最终查询结果。

5. 在返回结果/测试结果区域，查看测试结果。

   如果测试失败，您可以查看附录：错误码及解决方案。

6. 仅测试API时支持操作。单击底部的API授权按钮，支持将API授权给应用，详情请参见数据服务权限管理。

步骤二：发布API

后续业务应用用户可以在数据服务总览页面查询并申请调用API的权限。

附录：错误码及解决方案