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

权利要求书

1.一种接口契约优化调整方法，其特征在于，所述接口契约优化调整方法包括：

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

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

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

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

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

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

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

2.如权利要求1所述的接口契约优化调整方法，其特征在于，采用所述工具类对初始化之后的spring bean进行扫描包括扫描包含requestMapping、getMapping、postMapping注解的rest接口以及包含ESA注解的RPC接口，同时解析出入参和接口类型，并将解析得到的入参和接口类型保存至接口模型。

3.如权利要求1所述的接口契约优化调整方法，其特征在于，所述判断arena接口列表的接口数据与接口模型数据是否匹配包括：

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

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

若统一资源定位符、接口名称、出参、入参、参数类型全部与接口模型数据匹配，则判定arena接口列表的接口数据与接口模型数据匹配。

4.如权利要求1所述的接口契约优化调整方法，其特征在于，所述swagger注解包括Api注解、ApiOperation注解、ApiImplicitParams注解、ApiImplicitParam注解、ApiResponses注解和ApiResponse注解，其中，ApiImplicitParam注解包括指示参数所放置位置的paramType、参数名name、参数类型dataType、指示参数是否必须传的required、参数的注释value、参数的默认值defaultValue。

5.一种接口契约优化调整装置，其特征在于，所述接口契约优化调整装置包括：

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

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

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

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

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

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

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

6.如权利要求5所述的接口契约优化调整装置，其特征在于，采用所述工具类对初始化之后的spring bean进行扫描包括扫描包含requestMapping、getMapping、postMapping注解的rest接口以及包含ESA注解的RPC接口，同时解析出入参和接口类型，并将解析得到的入参和接口类型保存至接口模型。