[发明专利]一种基于应用系统群整体的API信息管理的方法

说明书

本发明涉及研发领域、测试技术领域，提供了一种基于应用系统群整体的API信息管理的方法。主旨方便项目组在研发、测试过程中，通过无感监控测试环境的接口请求和应答数据，自动更新当前系统的API信息，并通知项目相关方；方案将解决：跨系统的接口变更沟通完全依赖人工，极易出现遗漏和错误；测试人员无法准确获取当前版本内的接口变更范围，无法做到精准测试。主要方案包括：1.部署Splunk系统，逐步接入全部应用系统群，作为系统群日志管理系统；2.搭建API管理平台，a管理各类系统批量查询Splunk日志数据库脚本；b管理脚本启动与定时任务；c按时间存储脚本查询结果；3.解析查询结果，判断接口是否有变化；4.更新API信息并通知相关方。

技术领域

本发明涉及DevOps(持续交付)技术领域、软件研发领域，软件测试领域，是一种基于应用系统群整体的API信息管理方案，作为联动治理多系统的API信息的方法。

背景技术

DevOps(持续交付)：由配置管理、构建与持续集成、测试管理、部署与发布管理、环境管理、数据管理、度量与反馈7大能力子域，共14个能力项构成。使用闭环的工具、平台组合，强约束力代码分支策略手段，高覆盖率的自动化测试手段，强大的部署自动化手段确保项目管理流畅，高质量交付，部署可重复性。但在DevOps(持续交付)过程中，项目组的API管理工作很大程度依赖人工，系统群整体的APl管理比较困难，比如以下场景：

①项目组内部的接口文档的及时更新只出现在小范围内，研发与测试之间存在一定时差，没法及时交互，导致测试过程中经常发现接口文档错误，出现因文档错误阻断测试过程的现象；

②项目组内部无法准确知晓当前版本的接口变更范围，研发的变更范围依赖人工，当人员出现流动性和工作失误，可能会出现遗漏范围或者扩大范围，遗漏范围导致漏测，扩大范围导致人力成本增加；

③各项目组之间的接口文档的及时更新缺失，因上下游系统之前接口变更未及时沟通，导致单系统更改上线后，配套系统未及时更新从而出现生产问题；

④项目群下快速收集多套系统的API信息较为困难。

技术缺陷：

目前上线后出现生产事故，主要原因是第②和第③点引出的测试范围问题导致的，尤其第②点，项目组流动性过大时，对于存量代码的掌控很较弱，扩大范围后的回归测试可能依然无法避免漏测，而且极消耗人力成本。现有API管理的方案如下：

a.人工整理；

b.代码中集成开源的API管理框架，如swagger；

c.Excel文档整理后通过git进行版本控制；

其中a、c耗费人力，且容易出现更新不及时的情况，全部系统都能实现较高质量的API管理不太现实；b对原有的代码框架要求很高，不是所有系统都适用，存在推广难点，无法全部适配，推广效果会打折扣。

发明内容

本发明的目的在于解决系统群的API管理实施困难问题，从而减轻由文档更新不及时导致的研发测试失误出现的缺陷逃逸风险。

为了解决上述技术问题，本发明采用以下技术手段：

一种基于应用系统群整体的API信息管理的方案，包括以下步骤：

步骤1：对应用系统的测试环境循环抽取接口数据，得到纯报文日志；

步骤2：搭建API管理平台，用于数据查询脚本管理，包括以下模块：

数据脚本管理模块：用于在线维护脚本的增删改成；

脚本启动管理模块：根据使用场景设定脚本执行触发逻辑；

系统接口管理模块：可视化、格式化展示当前应用系统最新的接口清单和接口详情；