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

权利要求书

1.一种基于应用系统群整体的API信息管理的方法，其特征在于，包括以下步骤：

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

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

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

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

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

接口变更处理模块：分析接口数据，判断接口数据中是否存在格式变更，并提供特定时间范围内的接口变更记录查询功能；

步骤3：根据步骤2中搭建的数据脚本管理，开发人员在线编写脚本，脚本处理逻辑为：

步骤3.1、依次读取步骤1中获取的接口数据；

步骤3.2、分别存储接口数据中的请求格式、请求字段，返回格式和返回字段，并依次打上查询频率标记id与数据id；

步骤4：根据步骤2中搭建的脚本启动管理功能，在API管理平台设置脚本的查询频率、手工/定时启动方式；

步骤5：根据步骤2中搭建的脚本启动管理功能，通过手工启动和定时启动的方式来启动步骤3中编写的数据脚本，读取步骤4设置的查询频率来查询接口数据，每次查询时将本次查询周期内的接口信息数据，包括接口的请求格式、请求字段，返回格式和返回字段等数据进行解析存储入库；

步骤6：获得步骤5的节点信息数据后，API管理平台根据步骤2中搭建的接口变更处理功能，将历史接口信息与新数据进行去重对比，判断本次周期内的接口信息数据是否有变更，有变更则自动更新最新的接口清单和接口详情，同时通过企业微信通知相关方，API管理平台提供输出pdf格式的接口文档，供开发人员与测试人员使用。

2.根据权利要求1所述的一种基于应用系统群整体的API信息管理的方案，其特征在于，步骤1主要是部署Splunk系统并建立好索引，具体包括以下步骤：

步骤1.1：部署Splunk系统，通过Splunk对系统群下的应用系统的测试环境日志进行抓取，并存储到Splunk数据库中；

步骤1.2：为各类系统建立索引，加快查询数据；

步骤1.3：利用步骤1.2中建立的索引筛选纯报文日志；

3.根据权利1所述的一种基于应用系统群整体的APl信息管理的方案，其特征在于，步骤2主要是利用SpringBroot后端框架与VUE前端框架搭建搭建API管理平台用于数据查询脚本管理，具体实现包括：

步骤2.1：API管理平台提供数据查询脚本文件管理功能，包括脚本上传新增、在线编辑、在线调试、在线预览和删除功能，方便系统群下的开发人员线上编辑数据脚本；

步骤2.2：API管理平台提供数据查询脚本启动管理功能，包括管理脚本执行频率，启动方式，脚本热启动功能，方便系统群下的开发人员根据使用场景设定脚本执行触发逻辑；

步骤2.3：API管理平台提供可视化、格式化的接口清单和接口详情预览功能，方便系统群下的全体人员可实时查看最新的接口信息；

步骤2.4：API管理平台按频率批次存储数据脚本处理之后的接口数据，方便追溯某一版本下的接口的变更记录。

4.根据权利1所述的一种基于应用系统群整体的API信息管理的方案，其特征在于，步骤3为数据脚本编写阶段，系统群下的开发人员根据本应用系统的接口文档格式，在线编写数据查询处理脚本，脚本处理逻辑如下：

步骤3.1、数据处理脚本通过步骤1中获取的纯报文日志，提取报文中的请求码、请求字段、请求字段格式、返回字段、返回字段格式；

步骤3.2、数据处理脚本将步骤3.1中的请求码、请求字段、请求字段格式，返回字段、返回字段格式分别存储至APl管理平台，并打上查询频率标记id与数据id。

5.根据权利1所述的一种基于应用系统群整体的APl信息管理的方案，步骤4为设置脚本的查询频率和启动方式；