System.ArgumentOutOfRangeException: 索引和长度必须引用该字符串内的位置。 参数名: length 在 System.String.Substring(Int32 startIndex, Int32 length) 在 zhuanliShow.Bind() 一种接口管理方法及相关系统技术方案_技高网

一种接口管理方法及相关系统技术方案

技术编号:42719561 阅读:1 留言:0更新日期:2024-09-13 12:07
本申请提供了一种接口管理方法,应用于接口管理系统,接口管理系统用于对业务系统的API进行设计、检查或代码生成,该方法包括:提供配置界面,接收用户通过所述配置界面配置的目标业务系统的属性,包括业务所属行业领域、业务模块或用于对比的服务,然后根据目标业务系统的属性,通过存储有API资源及其关联信息的接口知识库,对目标业务系统的API进行管理,向用户呈现目标业务系统的API的管理结果,例如是呈现目标业务系统的API的设计文件、目标业务系统的API的检查结果、目标业务系统的API的代码中的一种或多种。如此通过复用接口知识库中已有的同类型项目工程的接口设计,能够提供快速设计一套业务完备的API的能力,也能够对API设计质量进行检查。

【技术实现步骤摘要】

本申请涉及软件开发,尤其涉及一种接口管理方法、系统、计算设备集群、计算机可读存储介质以及计算机程序产品。


技术介绍

1、应用程序编程接口(application programming interface,api),也可以简称为接口,是指操作系统或程序库提供给应用程序调用使用的代码,其主要目的是让开发者得以调用一组例程功能,而无须考虑其底层的源代码、或理解底层的源代码的内部工作机制的细节。如此可以提高开发消息、保障代码安全,此外还能实现不同的软件系统(或应用程序)相互通信。

2、为了更好地管理api并对api的全生命周期进行治理,开发者可以在开发应用程序或对功能进行集成时先设计api。目前,开发者通常是通过手工编写api的设计文件(也可以称作描述文件),或者手工填写api的设计表单,在设计文件或设计表单中对接口以及模型进行定义,从而完成api设计。

3、上述方法依赖开发者手工设计,设计门槛较高,一般需要有一定设计经验的开发者才能胜任,而且存在工作量大、容易出错、不完备、不规范等问题,难以满足业务需求。


技术实现思路

1、本申请提供了一种接口管理方法,该方法利用接口知识库中从大量api数据资产中提取的api资源以及api资源的关联信息进行api设计、api检查或api代码生成,实现api智能化管理,降低设计门槛以及设计工作量,并且降低出错概率以及api不完备或不规范的风险,能够满足业务需求。本申请还提供一种接口管理系统、计算设备集群、计算机可读存储介质以及计算机程序产品。

2、第一方面,本申请提供一种接口管理方法。该方法可以由接口管理系统执行。接口管理系统用于对业务系统的api进行设计、检查或代码生成。该接口管理系统可以是软件系统,例如是api开发工具,包括但不限于开发者桌面/web工具或者是集成开发环境(integrated development environment,ide)插件,上述软件系统可以是独立的软件系统,也可以是集成于已有软件系统。软件系统部署在计算设备集群中,计算设备集群执行软件系统的程序代码,从而执行本申请的接口管理方法。在一些示例中,接口管理系统也可以是硬件系统,例如是具有接口管理功能的计算设备集群,计算设备集群运行时,执行本申请的接口管理方法。

3、具体地,接口管理系统可以提供配置界面,接收用户通过配置界面配置的目标业务系统的属性,如业务所属行业领域、业务模块或用于对比的服务,然后根据目标业务系统的属性,通过接口知识库(如api知识库),对目标业务系统的api进行管理。其中,接口知识库包括从api数据资产中提取的api资源以及所述api资源的关联信息。接着接口管理系统向用户呈现所述目标业务系统的api的管理结果,例如是呈现目标业务系统的api的设计文件、目标业务系统的api的检查结果、目标业务系统的api的代码中的一种或多种。

4、该方法能够利用接口知识库中从大量api数据资产中提取的api资源以及api资源的关联信息进行api设计、api检查或api代码生成等api管理。一方面能够提供快速设计一套业务完备的api的能力,通过复用接口知识库中已有的同类型项目工程的接口设计及数据模型、安全模型等,避免重复开发,为开发设计api节约时间成本,提高整体开发效率及上线进度。另一方面,对于存量项目的api(也称作存量api),能够对api设计质量进行检查,发掘api设计不合理/冗余或缺失的问题,在业务功能完整的前提下,保证api设计的合理性、整洁性。

5、在一些可能的实现方式中,接口管理系统可以根据目标业务系统的属性,从接口知识库中确定参考api的信息,参考api为与目标业务系统的属性的业务语义的相似度满足预设条件的api,参考api的信息包括从参考api的api数据资产中提取的api资源以及api资源的关联信息,根据参考api的信息,生成目标业务系统的api的设计文件。

6、该方法通过结合目标业务系统的属性从接口知识库中确定参考api,如此可以复用参考api的api资源及其关联信息,生成目标业务系统的api的设计文件,避免重复开发,为开发设计api节约时间成本,提高整体开发效率及上线进度。

7、在一些可能的实现方式中,接口管理系统还可以接收所述用户通过配置界面配置的设计规范、设计规则或api模板中的一种或多种。相应地,接口管理系统可以根据参考api的信息,结合设计规范、设计规则或api模板,生成目标业务系统的api的设计文件。

8、该方法中,用户通过配置设计规范、设计规则或api模板,可以使得生成的api的设计文件的风格一致、规范化,有利于后续进行版本迭代。

9、在一些可能的实现方式中,接口管理系统还可以接收所述用户上传的所述目标业务系统的api的设计文件。相应地,接口管理系统在对api进行管理时,可以根据所述目标业务系统的属性,通过接口知识库,对所述目标业务系统的api的设计文件进行检查,获得所述目标业务系统的api的检查结果,所述检查结果包括缺失api的信息、冗余api的信息或合并api的信息中的一种或多种。

10、如此,可以实现对存量项目的api的设计文件进行智能检查,发掘api设计不合理/冗余或缺失的问题,减少人工检查,降低了检查成本。

11、在一些可能的实现方式中,接口知识库通过树或图存储api资源以及api资源的关联信息。相应地,接口管理系统可以根据目标业务系统的api的设计文件,构建目标业务系统的api的树或图,然后从接口知识库的树或图中确定目标节点。其中,目标节点为与目标业务系统的api的树或图中节点的业务语义的相似度满足预设条件的节点,接着根据目标节点以及目标业务系统的api的树或图中节点,对目标业务系统的api的设计文件进行检查。

12、该方法中,接口知识库可以将接口知识库中api资源及其关联信息以树或图的形式进行组织,接口管理系统通过将目标目标业务系统的api的设计文件也以树或图的形式进行组织,如此即可通过对目标业务系统的设计文件的树或图以及接口知识库的树或图进行业务语义挖掘,从而实现对目标业务系统的api的设计文件进行智能检查,提高了检查效率以及检查结果的准确度。

13、在一些可能的实现方式中,接口管理系统可以采用基于树或图的检查规则对目标业务系统的api的设计文件进行检查。具体地,接口管理系统可以根据所述目标节点以及所述目标业务系统的api的树或图中节点,确定丰富度信息、完备度信息或冗余度信息,根据所述丰富度信息、所述完备度信息或所述冗余度信息,对所述目标业务系统的api的设计文件进行检查。在一些示例中,接口管理系统也可以根据所述目标节点以及所述目标业务系统的api的树或图中节点,确定节点的出度、入度或邻接关系,根据所述节点的出度、入度或邻接关系,对所述目标业务系统的api的设计文件进行检查。在另一些示例中,接口管理系统也可以根据目标节点以及目标业务系统的api树或图中节点的距离、深度、密度或偏差,对所本文档来自技高网...

【技术保护点】

1.一种接口管理方法,其特征在于,应用于接口管理系统,所述接口管理系统用于对业务系统的应用程序编程接口API进行设计、检查或代码生成,所述方法包括:

2.根据权利要求1所述的方法,其特征在于,所述根据所述目标业务系统的属性,通过接口知识库,对所述目标业务系统的API进行管理,包括:

3.根据权利要求2所述的方法,其特征在于,所述方法还包括:

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

5.根据权利要求4所述的方法,其特征在于,所述方法还包括:

6.根据权利要求1至5任一项所述的方法,其特征在于,所述接口知识库通过如下方式构建:

7.根据权利要求1至6任一项所述的方法,其特征在于,所述API资源的关联信息包括以下信息中的一种或多种:业务场景、资产标签、方法、属性、操作、描述或概述。

8.一种接口管理系统,其特征在于,所述接口管理系统用于对业务系统的应用程序编程接口API进行设计、检查或代码生成,所述系统包括:

9.根据权利要求8所述的系统,其特征在于,所述管理子系统具体用于:

10.根据权利要求9所述的系统,其特征在于,所述配置子系统还用于:

11.根据权利要求8所述的系统,其特征在于,所述配置子系统还用于:

12.根据权利要求11所述的系统,其特征在于,所述管理子系统还用于:

13.根据权利要求8至12任一项所述的系统,其特征在于,所述系统还包括:

14.根据权利要求8至13任一项所述的系统,其特征在于,所述API资源的关联信息包括以下信息中的一种或多种:业务场景、资产标签、方法、属性、操作、描述或概述。

15.一种计算设备集群,其特征在于,所述计算设备集群包括至少一台计算设备,所述至少一台计算设备包括至少一个处理器和至少一个存储器,所述至少一个存储器中存储有计算机可读指令;所述至少一个处理器执行所述计算机可读指令,以使得所述计算设备集群执行如权利要求1至7中任一项所述的方法。

16.一种计算机可读存储介质,其特征在于,包括计算机可读指令;所述计算机可读指令用于实现权利要求1至7任一项所述的方法。

...

【技术特征摘要】

1.一种接口管理方法,其特征在于,应用于接口管理系统,所述接口管理系统用于对业务系统的应用程序编程接口api进行设计、检查或代码生成,所述方法包括:

2.根据权利要求1所述的方法,其特征在于,所述根据所述目标业务系统的属性,通过接口知识库,对所述目标业务系统的api进行管理,包括:

3.根据权利要求2所述的方法,其特征在于,所述方法还包括:

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

5.根据权利要求4所述的方法,其特征在于,所述方法还包括:

6.根据权利要求1至5任一项所述的方法,其特征在于,所述接口知识库通过如下方式构建:

7.根据权利要求1至6任一项所述的方法,其特征在于,所述api资源的关联信息包括以下信息中的一种或多种:业务场景、资产标签、方法、属性、操作、描述或概述。

8.一种接口管理系统,其特征在于,所述接口管理系统用于对业务系统的应用程序编程接口api进行设计、检查或代码生成,所述系统包括:

9.根据权利要求8所述的系统,...

【专利技术属性】
技术研发人员:叶一达刘亮
申请(专利权)人:华为云计算技术有限公司
类型:发明
国别省市:

网友询问留言 已有0条评论
  • 还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。

1