API多环境
数据服务支持在同一个环境下具有多套网关,对应API多套环境的功能。该功能需要在后台进行配置,页面才会支持展示多环境等相关功能。
多环境和同步配置流程
对于多环境下的API,平台提供线上、预发和测试等多环境间的配置同步和生成功能,下面以测试API为例,整体流程如下所示:
对于某环境下的API,若已有其他环境下的API,支持快速查看详情。如果无其他环境下的API,首先检测当前API是否处于发布状态,若为发布状态,则支持基于当前API快速生成其他环境下的API。同时,API处于发布状态且有其他环境下的API,支持快速将当前API的配置同步至其他环境下的API中,实现多环境下API的配置快速更新。
区分多环境类型
当开启API多环境配置之后,API将分为三种不同的状态:测试、预发和线上。同时,资源组和API均区分不同的环境,通过不同环境下的API绑定同等环境下的资源组。
参数信息 | 说明 |
---|---|
测试环境 | 使用测试数据,验证API取数罗的正确性。 |
预发环境 | 使用线上数据,验证线上数据以及取数逻辑的正确性。 |
线上环境 | 预发环境验证成功后,将该API发布至线上,拱客户调用。 |
说明: 不同状态下的API相互独立,仍然能够各自进行发布、测试和在线升级,但测试——预发——线上API又要保持关联,比如URL地址的后缀、调用方式、取数逻辑保持一致等。 |
在配置管理的资源组管理页面中创建资源组时,可选择资源组的环境类型:
在新建API时,也可以选择API所属的环境类型,在API列表和API集市中,均用不同环境的页签区分不同环境下的API。
生成/查看和同步配置
在API详情页面,可以生成/查看其他环境类型的API,也支持同步配置到其它环境。
列表API的详情页,可查看其它环境API、生成其它环境API和同步更新配置的功能键,功能键是否可用与当前API的状态以及其他环境API有关:
- 有其他环境类型API后,才可查看;
- 处于发布状态且未有其他环境类型API,才可生成;
- 处于发布状态且有其他环境类型API,才可同步更新配置。
支持不同环境下存在重名API,同一环境类型不允许API重名。
多环境下的注意事项
在使用多环境时,需要注意以下几点:
不同环境下的API,通过所属集合(集合path)和api path构建关联,若编辑某一环境下的API,修改集合或api path,会给出当前API存在多种环境,若修改集合或API Path,将无法和其他环境API构建关联的提示。
若修改某一种环境下的API,比如预发API同步更新其他环境API配置(即点击详情页的同步更新配置):
若被同步的API处于非发布状态,比如预发API,则进入编辑态,预发API会继承测试API除名称之外的所有内容,包括基本信息和取数逻辑;
若被同步的API处于发布状态,比如线上API,则进入升级态,线上API只会集成测试API的取数逻辑内容,比如数据结果缓存、入参等,对于基本信息,比如标签、描述等保持不变。
以上内容对您是否有帮助?