API版本管理

操作场景

数据服务专享版支持将API按照不同版本进行管理，可根据不同的API版本，分别进行调测、发布。

您也可以根据API版本追踪API的变更情况，支持版本对比。系统最多保留最近10条的版本记录，更早的版本记录会被删除。

前提条件

• 仅专享版支持API版本管理。
• API更新版本是通过对已发布的API进行编辑后再次发布实现的。API如果处于发布、下线、停用、恢复的待审核或待执行状态，则不支持编辑，因此无法更新版本。

更新API版本

API更新版本是通过对已发布的API进行编辑后，再次发布，从而实现版本更新。

1. 在DataArts Studio控制台首页，选择对应工作空间的“数据服务”模块，进入数据服务页面。

2. 在左侧导航栏选择专享版，进入总览页。
3. 进入“开发API > API管理”页面。确保待更新版本的API为已发布状态后，在API服务列表操作列中，选择“编辑”。
4. 在API编辑界面，您可以修改API的基础配置或取数逻辑，例如API目录、描述、请求方式、入参、取数方式等，注意API名称、请求path、参数协议、安全认证不支持修改。
   图1 修改API的基础配置或取数逻辑
   

5. API修改完成后，单击“下一步”进入测试页面。填写相关参数后，进行API测试。
   左侧为API请求参数配置区域，参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。

   表1 调试API

   参数名称	说明
   API版本	仅专享版支持指定API版本调试。 当未指定API版本时，默认调试的是未发布的API。
   参数配置	Query的参数与参数值。
   集群配置	仅专享版支持，选择调试API所依托的实例。

6. 测试完成后，单击“确定”返回API列表。已成功修改的API会在API名称后添加“已编辑”标签。
   图2 已编辑API
   

7. 再次发布已编辑的API。在API服务列表操作列中，选择“更多 > 发布”，然后选择已调试通过的集群进行发布。

   您可以将已编辑的API发布在上一次发布的集群上，该集群上的API信息将按编辑后的信息进行更新；您也可以将已编辑的API发布在其他集群上，则该API可以实现不同的版本发布在不同的集群上。

查看与对比版本

1. 在DataArts Studio控制台首页，选择对应工作空间的“数据服务”模块，进入数据服务页面。

2. 在左侧导航栏选择专享版，进入总览页。
3. 进入“开发API > API目录”或“开发API > API管理”页面，在API列表操作列中，单击API名称进入API详情页面。
4. 在API详情页面，单击“版本管理”，可查看当前保存的版本记录（最多保留最近10条）。
   您可以查看对应版本API的详细内容，也可以删除或发布对应版本。当勾选两个版本时，您也可以通过“版本对比”，对比两个版本之间的差异情况。

   图3 API版本管理