测试与发布API

前提条件

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

步骤一：测试API

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

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

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

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

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

   在顶部可以查看域名，该域名仅用于内部测试，实际调用域名，请参见查看域名。

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

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

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

      公共请求参数列表区域的参数包括PageStart、PageSize和OrderByList，根据API请求方式不同展示的参数不同。

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

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

        参数	描述	测试输入值
        PageStart	用于定义返回数据从第几条开始展示。	配置成正整数，例如2。
        PageSize	用于定义每页返回多少数据。	配置成正整数，例如56。
        OrderByList	用于定义多个返回参数的排序方式。如果没有填写，则默认为升序排列。	测试输入值需要从业务请求参数列表中获取。

   3. 在可选返回参数列表区域选择返回参数。

      可选返回参数列表区域展示的参数是您创建API时配置的返回参数。您需要选择至少一个返回参数才能测试API。

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

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

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

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

5. 在测试详情区域，查看测试结果。

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

步骤二：发布API

1. 在API列表页面，单击目标API操作列下的发布图标。

2. 在API发布对话框中，选择需要发布的版本。

   若API存在线上版本，系统将校验是否存在参数变更以及依赖，以此判断是否触发项目中设置的发布管控机制。您可以对目标API执行去回收、去查看操作。

   • 去回收：单击去回收跳转至管理中心 > 权限管理 > 数据服务权限（权限管理下）> API权限页签，当前API权限回收对话框，您可将该API权限回收。

   • 去查看：单击去查看跳转至服务 > 开发 > API页面，系统会为您筛选出当前API，您可以编辑该组合API，去除对该组合API的引用或删除组合API。

     若没有该组合API的权限，您可以联系对应的组合API负责人，进行编辑组合API去除对该API的引用或删除组合API。

     说明

     • 仅超级管理员和数据服务的项目管理员支持回收API权限。

     • 若线上已有发布的版本，则API发布新版本到线上的过程中会对参数进行校验，包括新增必填请求参数、删减请求参数、删减返回参数以及变更请求参数的数据类型，若存在任一变更，API发布将根据所属项目中设置的发布管控机制进行阻塞或发布。

       • 如果API发布管控中API已授权给应用设置为阻塞发布，则需要回收API的权限，才能继续发布。

       • 如果发布管控中API已被组合API引用设置为阻塞发布，则需要编辑组合API去除对该API的引用或删除组合API，才能继续发布。

       • 如果发布管控两个配置项都选择阻塞发布，则需要回收API权限的同时还需要编辑组合API去除对该API的引用或删除组合API，才能继续发布。

3. 单击确认，将API发布至生产环境。

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

   说明

   • 仅已提交的API支持发布到线上。

   • 新版本发布到线上会影响API的调用，您可以在项目中设置不同的发布管控机制，在API发布时会根据其所属项目的配置进行阻塞或发布，详情请参见创建服务项目。

   • 基于服务单元创建的API，在发布时会对引用的字段在所属的服务单元中是否存在进行校验；基于数据源创建的API，在发布时会对引用的字段在所属的数据源中是否存在进行校验。

   • 当开启数据服务高可用模块，基于数据源创建的API，在发布时不校验备链路的数据源及其该数据源中引用的表或字段是否存在。

附录：错误码及解决方案