查看及管理API

区域

描述

①筛选及搜索区

您可以根据API的名称或ID进行搜索，也可以快捷筛选我的API，或者根据API类型、API分组进行筛选。

②列表区

为您展示API的名称、API_ID、API类型、API分组、应用数、负责人、模式、当前状态、运行环境、发布版本、权限信息、发布信息等API详情。

权限信息：申请API的个人账号使用权限后，可以在组合API引用，申请权限请参见管理API权限。

③操作区

您可以对API执行发布、版本管理、转让负责人、删除操作。

• 发布：选择需要发布的已提交版本，将API发布至生产环境中。详情参见步骤二：发布API。

  说明

  • 若线上已有发布的版本，则API发布新版本到线上的过程中会对参数进行校验，包括新增必填请求参数、删减请求参数、删减返回参数、变更请求参数的数据类型。

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

• 版本管理：若下游应用调用API的API_ID无法修改，在API的数据源或查询条件发生变更后，可通过多版本的方式开发、测试后，再将新版本发布至生产环境中以覆盖原来的版本，避免下游应用端的调整。配置详情请参见API多版本管理。

• 转让负责人：可将API转让至该项目下的其他开发用户或项目管理员。

• 编辑：支持将API多版本的公共信息统一修改。在API编辑对话框，选择API分组，单击确定。

  

• 删除：API删除后不可撤销，请谨慎操作。

区域

描述

①API名称

为您展示当前API的名称。

②列表区

为您展示版本号、版本状态、创建人、更新时间信息。

③操作区

不同状态的版本您可以执行不同的操作。

当版本为草稿态时，您可以对新增版本执行编辑、删除操作。

当版本为已发布态且为线上已发布版本时（即线上正在使用版本），您可以对新增版本执行查看详情、测试、版本对比操作。

当版本为已发布态且非线上版本时（即历史发布版本），您可以对新增版本执行查看详情、测试、版本对比、删除操作。

当版本为已提交态时，您可以对新增版本执行查看详情、测试、版本对比、编辑、删除操作。

• 查看详情：您可以切换版本查看API的配置详情。仅支持查看已提交和已发布的版本。

• 测试：在测试环境，支持多个API共存并进行测试，根据调用不同的API测试效果，将反馈效果好的发布到线上应用。操作详情请参见步骤一：测试API。

• 版本对比：两个版本的配置信息进行对比会显示差异内容。

  说明

  • 仅支持已提交和已发布的版本进行对比。

  • 当仅有一个已提交或已发布版本时，不支持版本对比；草稿态的版本不支持进行对比。

  • 直连数据源API、SQL模式API（服务单元和逻辑表）、组合API支持脚本对比，便于开发者查看对比脚本内容。

• 编辑：支持修改API部分配置信息，修改后需重新提交API。

• 删除：当只有一个版本时，不支持删除。