一种接口管理方法及装置与流程

专利检索2025-07-11  11


本申请涉及软件开发,更具体的说,是涉及一种接口管理方法及装置。


背景技术:

1、接口是应用系统间进行通讯和信息交互的桥梁,应用系统通过接口对外提供服务,同时通过访问其他应用系统的接口获得服务和数据。随着云计算、微服务、devops等技术的普及和企业数字化转型的深入,接口已成为满足企业业务发展和数字化转型能力要求的重要因素。

2、目前流行的一些接口开发工具,如postman、swagger、apifox等,可提供接口设计、调试、代码生成、自动化测试、mock测试等功能,为接口全生命周期的关键节点提供功能支持,如通过接口的定义自动生成对应的代码、为接口自动生成测试用例、测试挡板等。但是,这类工具所提供的功能,是由接口服务方自行决定是不是要使用相关功能,不能强制要求服务方在开发接口的各个环节都使用工具,从而无法保证接口的文档和运行态代码始终是一致的。

3、综上,由于系统并行开发程度增加、迭代频率不断提升,给传统的接口开发、使用、管理带来了一系列需要解决的问题,如接口文档的更新不及时,与实际生产环境中运行的接口信息不一致,导致消费方在调用接口时缺少有效参考。


技术实现思路

1、有鉴于此,本申请提供如下技术方案:

2、一种接口管理方法,包括:

3、获得服务方的接口定义信息,所述接口定义信息包括参数和返回值;

4、基于所述接口定义信息进行接口发布,得到接口发布信息,所述接口发布信息包括接口名称;

5、基于所述接口名称、所述参数和所述返回值生成接口测试用例;

6、基于所述接口定义信息生成接口代码,并基于所述接口代码执行所述接口测试用例;

7、若执行不通过,调整关联信息并重新基于接口代码执行测试用例,直至所述测试用例执行通过;

8、其中,所述关联信息为所述接口代码或所述接口测试用例。

9、可选地,所述获得服务方的接口定义信息,包括:

10、通过接口开发工具进行文档驱动的接口定义,或通过接口文档生成工具进行代码驱动的接口定义,获得接口定义信息。

11、可选地,所述关联信息为接口测试用例,所述调整关联信息包括:

12、调整接口定义信息,调整后的接口定义信息包括调整参数和调整返回值;

13、基于调整的接口定义信息进行接口发布,得到调整发布信息,所述调整发布信息包括调整接口名称;

14、基于所述调整接口名称、所述调整参数和所述调整返回值生成调整后的接口测试用例。

15、可选地,还包括:

16、获得消费方的接口调用请求,所述接口调用请求中包括消费方标识、消费令牌和目标接口信息;

17、对所述消费方标识和所述消费令牌进行校验;

18、若校验通过,允许所述消费方调用与所述目标接口信息对应的目标接口。

19、可选地,在所述获得消费方的接口调用请求前,还包括:

20、获得消费方的接口消费申请;

21、若所述接口消费申请通过,记录消费方订阅接口的信息,并为所述消费方下发消费令牌。

22、可选地,在所述获得服务方的接口定义信息后,还包括:

23、基于所述接口定义信息生成模拟接口服务端,所述模拟接口服务端能够为消费方提供接口服务。

24、可选地,还包括:

25、在接口定义信息发生变更时,触发基于新的接口定义信息生成新的模拟接口服务端,并将接口定义信息的变更消息发送至消费方。

26、可选地,所述基于所述接口定义信息进行接口发布,得到接口发布信息,包括:

27、控制服务方通过接口定义导入方式,将所述接口定义信息登记并进行接口发布。

28、可选地,基于所述接口定义信息进行接口发布,得到接口发布信息的步骤嵌入流水线应用自动执行。

29、本申请还公开了一种接口管理装置,包括:

30、接口定义获得模块,用于获得服务方的接口定义信息,所述接口定义信息包括参数和返回值;

31、接口发布模块,用于基于所述接口定义信息进行接口发布,得到接口发布信息,所述接口发布信息包括接口名称;

32、测试用例生成模块,用于基于所述接口名称、所述参数和所述返回值生成接口测试用例;

33、代码提交模块,用于基于所述接口定义信息生成接口代码,并基于所述接口代码执行所述接口测试用例;

34、信息调整模块,用于在所述代码提交模块执行所述接口测试用例不通过时,调整关联信息并重新基于接口代码执行测试用例,直至所述代码提交模块执行测试用例通过;

35、其中,所述关联信息为所述接口代码或所述接口测试用例。

36、经由上述的技术方案可知,本申请实施例公开了一种接口管理方法及装置,该方案在获得接口定义信息后,会基于接口定义信息进行接口发布,并基于接口定义信息和接口发布内容生成对应的接口测试用例,后续在基于接口定义信息生成接口代码并提交时,会自动触发之前生成的接口测试用例执行,若执行通过,则允许接口代码提交,若执行不通过则会调整相关内容直至接口测试用例通过,从而保证了接口定义信息、接口发布内容和接口代码的一致性。



技术特征:

1.一种接口管理方法,其特征在于,包括:

2.根据权利要求1所述的接口管理方法,其特征在于,所述获得服务方的接口定义信息,包括:

3.根据权利要求1所述的接口管理方法,其特征在于,所述关联信息为接口测试用例,所述调整关联信息包括:

4.根据权利要求1所述的接口管理方法,其特征在于,还包括:

5.根据权利要求4所述的接口管理方法,其特征在于,在所述获得消费方的接口调用请求前,还包括:

6.根据权利要求1所述的接口管理方法,其特征在于,在所述获得服务方的接口定义信息后,还包括:

7.根据权利要求6所述的接口管理方法,其特征在于,还包括:

8.根据权利要求1所述的接口管理方法,其特征在于,所述基于所述接口定义信息进行接口发布,得到接口发布信息,包括:

9.根据权利要求1-8任一项所述的接口管理方法,其特征在于,基于所述接口定义信息进行接口发布,得到接口发布信息的步骤嵌入流水线应用自动执行。

10.一种接口管理装置,其特征在于,包括:


技术总结
本申请公开了一种接口管理方法及装置,包括:获得服务方的接口定义信息,接口定义信息包括参数和返回值;基于接口定义信息进行接口发布,得到接口发布信息,接口发布信息包括接口名称;基于接口名称、参数和返回值生成接口测试用例;基于接口定义信息生成接口代码,并基于接口代码执行接口测试用例;若执行不通过,调整关联信息并重新基于接口代码执行测试用例,直至测试用例执行通过;其中,关联信息为所述接口代码或所述接口测试用例。该方案的接口测试用例和接口代码基于接口定义信息获得,在接口代码并提交时,会自动触发之前生成的接口测试用例执行,若执行不通过则会调整相关内容直至接口测试用例通过,保证接口登记态与运行态信息一致性。

技术研发人员:张洁,岳松颂
受保护的技术使用者:中国农业银行股份有限公司
技术研发日:
技术公布日:2024/5/29
转载请注明原文地址:https://win.8miu.com/read-1156183.html

最新回复(0)