大部分企业经常使用多套环境开展接口的开发和管理工作,若在测试环境完成一批接口测试的工作后,需要迁移到生产环境投入使用。在接口迁移的过程中,环境差异化会导致跨环境迁移的问题,企业要想解决此问题,一般需要额外耗费人力。
为了提高开发以及部署效率,得帆云iPaaS推出「API批量导入导出」功能,仅需两步即可实现接口跨环境迁移。
场景示例
某公司搭建iPaaS开发、测试和生产三套环境,用于进一步管控接口开发上线流程。现阶段在测试环境SAP应用系统下已有10+个接口完成设计、开发和测试工作,经过应用系统负责人验证,可以将该批接口迁移至生产环境中,实现接口投入使用。
操作步骤
步骤一:从测试环境批量导出接口
1、选择需要导出的API
进入测试环境,选择需要导出的API。导出功能支持以应用系统或API维度批量导出API,应用系统适合“首次批量迁移”,单个API适合“后续API的迭代升级”。
-
API维度:在「API开发-序号列」点击第一行的空白勾选框全选API后,再点击右上方「批量导出」。
「测试环境系统- API开发」
-
应用系统维度:在「系统设置-应用系统管理」SAP系统的操作栏下拉选择「导出API」。
「系统-应用系统管理:导出API」
2、确定导出细节
在「导出API」弹窗中通过勾选进行导出API的确定,支持展开API后查看和勾选版本,满足需要将导出内容的颗粒度细化至API某个版本的场景。完成上述操作后点击导出,系统会自动导出以应用系统名称命名的zip文件至下载内容中。
Tips:导出的zip文件含有API基本信息和关联资源信息,建议不要解压、编辑,会影响导入准确率。
「导出API确认弹窗」
「成功导出文件效果」
操作步骤
步骤二:批量导入接口至生产环境
1、进入「导入API」弹窗
进入生产环境,在「API开发」菜单中点击「导入」功能按钮,进入「导入API」弹窗。
「生产环境系统- API开发」
2、上传导出文件
通过文件拖拽或点击上传的方式,上传步骤一中导出的zip文件,导入后点击下方提示中的蓝色字样「API开发-导入记录」,快捷进入「文件上传记录」页面。
「导入API-文件上传窗」
3、进行导入操作
在「文件上传记录」页面查看当前租户下所有文件导入记录,选择“SAP系统.zip”文件的「导入」操作。
「导入API-文件上传记录」
4、导入API
第一步:导入API确定,系统解析导入文件,将文件中API划分为以下三类,用户可通过弹窗勾选确定导入API及对应版本号的导入方式。
-
无法导入:API编码和当前租户一个API重复,Path和另一个API重复情况。
-
导入新建:以新建的方式导入API。
-
导入覆盖:若API编码和Path与当前租户内已有API重复,将以完全覆盖的方式导入API。
「导入API-导入API确定」
第二步:关联应用系统,确定创建API的应用系统,系统会自动识别导入API所属应用系统的编码。支持点击「查看API」查看原始关联应用系统下的API列表。
-
若应用系统编码一致则自动匹配映射条件,后续步骤中将在映射的应用系统下创建API。
-
若应用系统编码不一致则自动匹配跳过条件,后续步骤中将跳过该类API的创建。若想继续导入API,支持手动选择映射的应用系统。
「导入API-关联应用系统」
「导入API-关联应用系统-查看原始关联应用系统API列表」
第三步:API资源映射,部分API除基本信息外还含有资源的配置。为了保证API导入后即可发布使用,需要对常用数据源、配置资源和自开发资源进行资源映射。本次批量导入的API中,部分API含有SAP连接的配置资源,需要映射该资源来完成API的创建。
-
映射:配置资源编码一致,含有该配置资源的API,导入系统时将自动映射配置资源。
-
继续:配置资源编码不一致,导入系统时该类API不映射配置资源。
-
跳过:配置资源编码不一致,导入系统时跳过该类API创建。
「导入API- API资源映射」
第四步:导入API,系统将会自动在系统内完成API的创建或覆盖,支持在下方点击「查看详情」查看单条API的导入状态。
Tips:导入数据量大小和网络原因都会影响导入速度,支持关闭弹窗,关闭后导入任务会在后台进行,后续可在「API开发-导入记录」查看本次导入结果。
「导入API-批量创建API」
「导入API-导入结果详情」
完成上述步骤后,刷新「API开发」页面查看成功导入的API数据,导入后的API使用API开发-批量发布功能,即可完成接口上线运行。
「系统- API开发」
得帆云iPaaS「批量导入导出API」功能,用简单的两个步骤即可高效解决接口跨环境迁移的问题。使用同系统跨环境进行接口的集成管理,能够提高接口跨环境迁移的适配性,帮助企业减少人力资源投入,提升开发和部署效率。