API多环境

在同一个环境下支持多套网关,对应API多套环境的功能(该功能在v1.4.4版本支持,若无该功能,则需升级至对应版本),该功能需要后台配置开启,页面才支持展示多环境等相关功能。

1、多环境和同步配置流程

对于多环境下的API,平台提供线上、预发和测试等多环境间的配置同步和生成功能,下面以测试API为例,整体流程如下所示:

API多环境 - 图1 2021-08-27-11-29-04.png

对于某环境下的API,若已有其他环境下的API,支持快速查看详情,若无其他环境下的API,首先检测当前API是否处于发布状态,若为发布状态,则支持基于当前API快速生成其他环境下的API。同时,API处于发布状态且有其他环境下的API,支持快速将当前API的配置同步至其他环境下的API中,实现多环境下API的配置快速更新。

2、区分多环境类型

首先,在创建资源组时,可选择资源组的环境类型,资源组列表中支持根据环境类型进行筛选。

API多环境 - 图3 2021-08-27-11-29-16.png API多环境 - 图5 2021-08-27-11-29-28.png

然后,在新建API时,也可以选择API所属的环境类型,在API列表和API集市中,均用不同环境的Tab区分不同环境下的API。

API多环境 - 图7 2021-08-27-11-29-40.png API多环境 - 图9 2021-08-27-11-29-52.png API多环境 - 图11 2021-08-27-11-30-03.png

3、生成/查看和同步配置

在API详情页面,可以生成/查看其他环境类型的API,也支持同步配置到其他环境。

列表和集市的API,详情页中均增加环境标识,可快速识别API处于何种环境。

API多环境 - 图13 2021-08-27-11-30-32.png API多环境 - 图15 2021-08-27-11-30-46.png

列表API的详情页,可查看其他环境API、生成其他环境API和同步更新配置的功能键,功能键是否可用与当前API的状态以及其他环境API有关:(1)有其他环境类型API后,才可查看;(2)处于发布状态且未有其他环境类型API,才可生成;(3)处于发布状态且有其他环境类型API,才可同步更新配置。

支持不同环境下存在重名API,同一环境类型不允许API重名。

4、多环境下的注意事项

(1). 不同环境下的API,通过所属集合(集合path)和api path构建关联,若编辑某一环境下的API,修改集合或api path,会给出提示:

当前API存在多种环境,若修改集合或API Path,将无法和其他环境API构建关联。

API多环境 - 图17 2021-08-27-11-31-05.png

(2). 若修改某一种环境下的API,比如测试API,同步更新其他环境API配置(即点击详情页的”同步更新配置”):

API多环境 - 图19 2021-08-27-11-31-22.png

(I)若被同步的API处于非发布状态,比如预发API,则进入编辑态,预发API会继承测试API除名称之外的所有内容,包括基本信息和取数逻辑;

API多环境 - 图21 2021-08-27-11-31-40.png

(II)若被同步的API处于发布状态,比如线上API,则进入升级态,线上API只会集成测试API的取数逻辑内容,比如数据结果缓存、入参等,对于基本信息,比如标签、描述等保持不变;

API多环境 - 图23 2021-08-27-11-31-56.png