[发明专利]一种接口契约优化调整方法和装置

说明书

本申请涉及一种接口契约优化调整方法、装置、终端和计算机可读存储介质。接口契约优化调整方法包括：当spring bean初始化之后采用工具类进行拦截和扫描；若扫描结果中restrpc接口模型中包含注解swagger，自动覆盖arena上的接口协议，进而无需手动在arena上配置接口协议即可保持跟代码中接口协议一致；若扫描结果中restrpc接口模型中不包含swagger注解，将不包含swagger注解的restrpc接口模型上报至接口协议治理系统进行后续处理；接口协议治理系统按照预设周期扫描arena接口列表，并判断arena接口列表的接口数据与接口模型数据是否匹配；若arena接口列表的接口数据与接口模型数据不匹配，采用swagger的方式进行自动化整改和发布，既可以接口协议的自动化监测和更新，还可以提升研发效能和接口协议测试效率。

技术领域

本申请涉及数据接口优化处理技术领域，尤其涉及一种接口契约优化调整方法和装置。

背景技术

提高研发效能是一件亘古不变的话题，高效的研发效能能让厂商具有先天的市场优势，能及时交付产品抢占市场。而接口契约治理是研发效能中非常重要的一项，它是实现前后端并行开发的纽带，同时也为接口自动化测试提供入参参照，可极大节省研发时间成本，提高产能。

日常前后端开发过程中，由后端开发人员在arena或在yapi上维护接口协议，但是否维护、维护是否及时或则接口协议是否保持最新版本完全受后端开发人员的主观意识，完全没有一个监控工具去校验接口协议是否已维护、是否最新版本，这显然是不合理的。同时测试人员基于接口协议进行自动化测试时也需要跟开发人员进行二次确认，确保接口协议存在并且是最新版本，才会编写自动化测试案例完成接口测试，导致测试人员的测试效率低下。

发明内容

本申请提供一种接口契约优化调整方法和装置，既可以接口协议的自动化监测和更新，还可以提升研发效能和接口协议测试效率。

本申请的技术方案如下：

根据本申请实施例的第一方面，提供一种接口契约优化调整方法包括：

接收应用启动指令并初始化设置一个特定的工具类；

当spring bean初始化之后采用所述工具类进行拦截和扫描；

若扫描结果中restrpc接口模型中包含注解swagger，自动覆盖arena上的接口协议；

若扫描结果中restrpc接口模型中不包含swagger注解，将不包含swagger注解的restrpc接口模型上报至接口协议治理系统进行后续处理；

接口协议治理系统按照预设周期扫描arena接口列表，并判断arena接口列表的接口数据与接口模型数据是否匹配；

若arena接口列表的接口数据与接口模型数据不匹配，则生成告警信息提示接口协议需要更改；

采用swagger的方式对告警的接口协议进行自动化整改和发布，以便实现arena接口列表的接口数据与接口模型数据匹配。

可选的，采用所述工具类对初始化之后的spring bean进行扫描包括扫描包含requestMapping、getMapping、postMapping注解的rest接口以及包含ESA注解的RPC接口，同时解析出入参和接口类型，并将解析得到的入参和接口类型保存至接口模型。

可选的，所述判断arena接口列表的接口数据与接口模型数据是否匹配包括：

比较arena接口列表的接口数据与接口模型数据是否匹配，其中，所述接口数据包括统一资源定位符、接口名称、出参、入参、参数类型；

若统一资源定位符、接口名称、出参、入参、参数类型中的至少一个与接口模型数据不匹配，则判定arena接口列表的接口数据与接口模型数据不匹配；