CN113535830A - 接口自动扩展方法、装置、设备及存储介质 - Google Patents

Abstract

本发明公开了接口自动扩展方法、装置、设备及存储介质。该方法包括：获取用户输入的接口选择信息；当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数；替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口，提高了对外服务接口扩展的效率。

Description

接口自动扩展方法、装置、设备及存储介质

技术领域

本发明属于数据库技术领域，尤其涉及接口自动扩展方法、装置、设备及存储介质。

背景技术

随着“互联网+”技术的不断发展，越来越多的企业步入了互联网技术(InternetTechnology，IT)时代。为确保IT的软硬件配置数据可靠性和准确性，企业采用配置管理数据库(Configuration Management Database，CMDB)作为企业软硬件配置的数据管理工具。CMDB主要包括整合、调和、同步、映射和可视化五大关键功能。

目前，IT运维主要采用接口的方式，完成对外提供服务。例如，可以根据不同用户需求和业务场景不断进行CMDB数据服务接口的定制化开发、编译和调试。还可以提前预先配置数据服务通用接口，如数据新增接口、数据删除接口、数据检索接口等接口。用户需要消费数据时可以直接调用对应的接口即可。

但是，上述采用接口的方式中对外提供服务均需要研发人员对接口代码进行二次或多次开发、编译、接口文档编写和双方接口联调等工作，效率较低。

发明内容

本发明实施例提供接口自动扩展方法、装置、设备及存储介质，能够提高对外服务接口扩展的效率。

第一方面，提供了一种接口自动扩展方法，该方法包括：

获取用户输入的接口选择信息；

当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数；

替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口。

在一种可能的实现方式中，该方法还包括：

当接口选择信息为新增接口信息时，接收用户输入的接口参数；

检验接口参数是否满足预设的参数属性；

当接口参数满足预设的参数属性时，生成目标接口。

在一种可能的实现方式中，该方法还包括：

当接口参数不满足预设的参数属性时，生成异常提示信息，以用于提示用户填写接口参数。

在一种可能的实现方式中，该方法还包括：

根据接口扩展参数，生成调用样板代码，以用于目标系统进行接口调用。

在一种可能的实现方式中，该方法还包括：

生成扩展服务接口的接口文档，以用于向用户展示接口文档。

第二方面，提供了一种接口自动扩展装置，装置包括：

获取模块，用于获取接口选择信息；

确定模块，用于当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数；

生成模块，用于替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口。

在一种可能的实现方式中，该装置还包括：

接收模块，用于当接口选择信息为新增接口信息时，接收用户输入的接口参数；

检验模块，用于检验接口参数是否满足预设的参数属性；

生成模块，还用于当接口参数满足预设的参数属性时，生成目标接口。

在一种可能的实现方式中，生成模块，还用于当接口参数不满足预设的参数属性时，生成异常提示信息，以用于提示用户填写接口参数。

在一种可能的实现方式中，生成模块，还用于根据接口扩展参数，生成调用样板代码，以用于目标系统进行接口调用。

在一种可能的实现方式中，生成模块，还用于生成扩展服务接口的接口文档，以用于向用户展示接口文档。

第三方面，提供了一种电子设备，该设备包括：处理器以及存储有计算机程序指令的存储器；处理器执行计算机程序指令时实现如第一方面或者第一方面的任一可能实现方式中的方法。

第四方面，提供了一种计算机存储介质，该计算机存储介质上存储有计算机程序指令，计算机程序指令被处理器执行时实现如第一方面或者第一方面的任一可能实现方式中的方法。

基于提供的接口自动扩展方法、装置、设备及存储介质，通过获取用户输入的接口选择信息；当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数；替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口，提高了对外服务接口扩展的效率。

附图说明

为了更清楚地说明本发明实施例的技术方案，下面将对本发明实施例中所需要使用的附图作简单的介绍，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是本发明实施例提供的一种接口自动扩展的流程示意图；

图2是本发明实施例提供的另一种接口自动扩展的流程示意图；

图3是本发明实施例提供的一种接口自动扩展装置的结构示意图；

图4是本发明实施例提供的电子设备的结构示意图。

具体实施方式

下面将详细描述本发明的各个方面的特征和示例性实施例，为了使本发明的目的、技术方案及优点更加清楚明白，以下结合附图及具体实施例，对本发明进行进一步详细描述。应理解，此处所描述的具体实施例仅被配置为解释本发明，并不被配置为限定本发明。对于本领域技术人员来说，本发明可以在不需要这些具体细节中的一些细节的情况下实施。下面对实施例的描述仅仅是为了通过示出本发明的示例来提供对本发明更好的理解。

需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括……”限定的要素，并不排除在包括要素的过程、方法、物品或者设备中还存在另外的相同要素。

随着“互联网+”技术的不断发展，越来越多的企业步入了互联网技术IT时代。为确保IT的软硬件配置数据可靠性和准确性，企业采用配置CMDB作为企业软硬件配置的数据管理工具。CMDB主要包括整合、调和、同步、映射和可视化五大关键功能。

目前，IT运维主要采用接口的方式，完成对外提供服务。例如，可以根据不同用户需求和业务场景不断进行CMDB数据服务接口的定制化开发、编译和调试。还可以提前预先配置数据服务通用接口，如数据新增接口、数据删除接口、数据检索接口等接口。用户需要消费数据时可以直接调用对应的接口即可。

但是，上述采用接口的方式中对外提供服务均需要研发人员对接口代码进行二次或多次开发、编译、接口文档编写和双方接口联调等工作，效率较低。例如，如针对预先配置数据服务通用接口的方式，若用户需要按设备类型，如主机、虚拟机等单独开放配置数据的增加、删除、修改、查询等更细粒度的扩展服务接口，则开发就需要调整通用接口代码、修订接口文档并和第三方系统联调，耗时耗力。此外，当变更原有的配置数据服务接口或新增特殊的配置数据服务接口时，需要研发人员不断调整代码并反复进行接口联调，耗费大量的开发成本。而且，在接口开发中研发人员不仅要编写接口代码，同时还要按照接口规范提供完善的接口文档，大量的接口文件编辑工作浪费了研发人员的大量时间。而手动批量更新接口文档难免会遗漏或出错，且基于接口文档的协作比较困难，因此，在接口文档管理方面也存在一定难度。

那么，在CMDB数据服务接口方面，如何既能快速满足用户需求、适配多样的业务场景，又能为研发人员减轻接口开发和文档管理的工作量是企业当前亟需解决的问题。

因此，本发明实施例提供了接口自动扩展方法、装置、设备及存储介质，能够提高对外服务接口扩展的效率。

为了方便理解本发明实施例，首先对本发明实施例提供的接口自动扩展的方法进行详细阐述。

图1是本发明实施例提供的一种接口自动扩展的方法的流程示意图。

如图1所示，本发明实施例提供的接口自动扩展的方法，包括：

S101：获取用户输入的接口选择信息。

接口包括不同类型的接口，在用户需要进行接口扩展的时候，可以根据自己的需要选择不同类型的接口。用户可以通过接口扩展服务平台选择需要扩展的接口类型，接口扩展服务平台可以是一个全球广域网界面(World Wide，Web)端。

接口扩展包括扩展原有的服务接口，还可以是增加新的服务接口。接口选择信息包括扩展接口信息和新增接口信息。其中，扩展接口信息为扩展原有的服务接口的信息，扩展接口信息包括了扩展接口的参数。扩展接口的参数包括扩展纬度信息，如按照主机、虚拟机、磁盘阵列等设备类型分级扩展，以及接口扩展后的主目录名称。例如，将CMDB查询接口按照设备类型扩展出主机查询接口、防火墙查询接口时，那么扩展纬度信息为按设备类型分级扩展，服务接口扩展后的主目录名称为CMDB按设备类型查询接口。新增接口信息包括请求参数，如接口参数的名称，接口参数的类型、接口参数的是否为必填的接口参数和接口说明，以及返回参数、接口描述、接口的请求方式等信息。

S102：当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数。

当接口选择信息为扩展接口信息时，需要在原有的服务接口的基础上对接口进行扩展。参数配置库是一个为可扩展的服务接口对应的参数信息提供对应的编码的数据库，用于存储CMDB原通用服务接口中传递变量参数对应的编码值。例如，将设备类型作为传递变量参数。参数配置库中对应的编码可以包括：主机的编码10001000，防火墙的编码10503022等。参数配置库根据一定的编码要求来确定，例如，企业之间的编码要求是不一样的，需要根据企业之间的编码要求来确定参数配置库。

由于扩展服务接口是建立在原服务接口参数信息上，因此系统自动将原服务接口请求参数、响应参数、返回状态码等按新服务分级接口即可模拟生成新服务分级接口信息。

当接口选择信息为新增接口信息时，用户会根据接口扩展服务平台提供的接口参数填写模板对需要新增的接口参数进行输入。

具体的，当所述接口选择信息为新增接口信息时，接收用户输入的接口参数；

检验所述接口参数是否满足预设的参数属性；

当所述接口参数满足所述预设的参数属性时，生成目标接口。

接口参数是指用户需要新增接口的接口参数。新增接口的接口参数具有一定的参数属性。例如，参数属性可以是接口参数为必填项或者非必填项。检测用户输入的接口参数是否为空，当接口参数的参数属性为必填项而用户输入的接口参数为空时，生成异常提示信息。其中，异常提示信息能够提示用户填写接口参数。

S103：替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口。

通过将从参数配置库中匹配到的编码值批量替换CMDB原服务接口中的传递变量参数的方式，自动封装接口参数对应的编码形成新的扩展服务接口，无需重新代码编写和编译即可使用。

例如，CMDB原服务查询接口统一资源定位系统(Uniform Resource Locator，URL)为http://ip:port/cmdb/data/{object Class}/{sysIntId}，变量参数有{object Class}和{sysIntId}，则将扫描出的编码值批量替换变量参数{objectClass}。将替换后的原服务查询接口进行封装，批量生成扩展服务接口，并对封装后的扩展服务接口命名如主机查询接口的URL为http://ip:port/cmdb/data/10001000/{sysIntId}。

在一些实施例中，在接口参数对应的编码封装过程中，还可以根据接口扩展参数自动生成调用样板代码，为目标系统调用提供代码样例，如第三方系统调用提供代码样例，方便了研发人员进行接口联调测试。

接口扩展完成后，会生成接口文档，并通过Web界面进行展示给用户，使用户能够对接口参数进行查阅等。

作为一个示例，如图2所示，本发明实施例提供的接口自动扩展方法包括：

S201：获取接口选择信息。用户选择扩展原服务分级接口还是新增服务接口。

S202：根据前台选择的标签判断是否是扩展服务接口；若是，执行S203；若否，执行S201。

当接口选择信息为原服务接口扩展时，Web页面扫描库表已有原服务接口列表进行展示，并提供扩展时需配置的规则参数；当接口选择信息为新增服务接口时，Web页面展示新增接口需填写的参数。

S203：针对接口选择信息为原服务接口扩展，确定需要扩展的原服务接口并填写对应的分级接口生成规则参数，如将CMDB查询接口按照设备类型扩展出主机查询接口、防火墙查询接口时，需要在扩展纬度参数时选择“按设备类型分级扩展”、填写服务接口扩展后的主目录名称“CMDB按设备类型查询接口”。

S204：从预设的参数配置库中确定接口扩展参数。

系统按照前台配置的生成规则自动扫描服务分级接口预设字典库。识别出按设备类型分级扩展，并通过后台扫描预设字典库，提取出有关设备类型：主机、防火墙、虚拟机、磁盘阵列等对应的编码值。执行S205。

S205：将提取的编码值替换原服务接口传参变量。如CMDB原服务查询接口URL为http://ip:port/cmdb/data/{objectClass}/{sysIntId}，变量参数有{objectClass}和{sysIntId}，则将扫描出的编码值批量替换变量参数{objectClass}。

S206：将替换后的原服务查询接口进行封装，批量生成新的服务分级接口，并对封装后的服务分级接口命名如主机查询接口的URL为http://ip:port/cmdb/data/10001000/{sysIntId}。

S207：针对每个新生成的服务分级接口返回报文参数自动生成调用样板代码。所述调用样板代码是模拟服务分级接口被调用情况下的第三方系统使用代码，为第三方系统的接口调用提供代码样例，其可通过可视化界面检索获得。

S208：针对每个新生成服务分级接口自动生成对应的接口文档。由于服务分级接口是建立在原服务接口参数信息上，因此系统自动将原服务接口请求参数、响应参数、返回状态码等按新服务分级接口即可模拟生成新服务分级接口信息。

在S208执行完成生成对应的接口文档后，执行S211。

S211：通过可视化界面展示CMDB服务分级扩展接口信息，为第三方系统使用提供服务接口调用方式检索，包括接口名称、接口请求方式、响应URL、请求报文、返回报文等。展示方式为以主目录和分级目录的方式展示新的服务分级接口，分级目录按照不同类型的接口请求方式展示，有效管理CMDB服务接口文档并通过数据共享的方式为使用者提供查阅。

S209：针对选择信息为新增服务接口，将配置新增服务接口的相关参数，如请求参数、返回参数、接口描述、接口请求方式等，并校验所填写参数是否满足属性要求，并提供服务接口参数配置的异常提示，如xx参数为必填参数，请填写。

S210：基于新增服务接口，如新增CMDB特殊接口，系统按照数据库中预先配置的代码生成规约填入前台配置参数，每条规约均对应的集成了接口通用的代码块。在S210执行完成生成新增服务接口之后，执行S211。

本发明实施例提供的接口自动扩展方法，通过获取用户输入的接口选择信息；当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数；替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口，提高了对外服务接口扩展的效率。

图3是本发明实施例提供的一种接口自动扩展装置的结构示意图。

如图3所示，本发明实施例提供的一种接口自动扩展装置，该装置可以包括：获取模块301，确定模块302，生成模块303。

获取模块301，用于获取接口选择信息；

确定模块302，用于当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数；

生成模块303，用于替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口。

可选的，在本发明的一些实施例中，该装置还包括：

接收模块，用于当接口选择信息为新增接口信息时，接收用户输入的接口参数；

检验模块，用于检验接口参数是否满足预设的参数属性；

生成模块303，还用于当接口参数满足预设的参数属性时，生成目标接口。

可选的，在本发明的一些实施例中，生成模块303，还用于当接口参数不满足预设的参数属性时，生成异常提示信息，以用于提示用户填写接口参数。

可选的，在本发明的一些实施例中，生成模块303，还用于根据接口扩展参数，生成调用样板代码，以用于目标系统进行接口调用。

可选的，在本发明的一些实施例中，生成模块303，还用于生成扩展服务接口的接口文档，以用于向用户展示接口文档。

本发明实施例提供的接口自动扩展装置，通过获取模块，用于获取接口选择信息；确定模块，用于当接口选择信息为扩展接口信息时，根据接口选择信息从预设的参数配置库中确定接口扩展参数；生成模块，用于替换当前服务接口的接口参数为接口扩展参数，生成扩展服务接口，提高了对外服务接口扩展的效率。

本发明实施例提供的接口自动扩展装置执行图1所示的方法中的各个步骤，并能够达到提高对外服务接口扩展的效率的技术效果，为简洁描述，再此不在详细赘述。

图4示出了本发明实施例提供的一种电子设备的硬件结构示意图。

在电子设备可以包括处理器401以及存储有计算机程序指令的存储器402。

具体地，上述处理器401可以包括中央处理器(CPU)，或者特定集成电路(Application Specific Integrated Circuit，ASIC)，或者可以被配置成实施本发明实施例的一个或多个集成电路。

存储器402可以包括用于数据或指令的大容量存储器。举例来说而非限制，存储器402可包括硬盘驱动器(Hard Disk Drive，HDD)、软盘驱动器、闪存、光盘、磁光盘、磁带或通用串行总线(Universal Serial Bus，USB)驱动器或者两个或更多个以上这些的组合。在合适的情况下，存储器402可包括可移除或不可移除(或固定)的介质。在合适的情况下，存储器402可在综合网关容灾设备的内部或外部。在特定实施例中，存储器402是非易失性固态存储器。在特定实施例中，存储器402包括只读存储器(ROM)。在合适的情况下，该ROM可以是掩模编程的ROM、可编程ROM(PROM)、可擦除PROM(EPROM)、电可擦除PROM(EEPROM)、电可改写ROM(EAROM)或闪存或者两个或更多个以上这些的组合。

处理器401通过读取并执行存储器402中存储的计算机程序指令，以实现图1和图2所示实施例中的任意一种接口自动扩展方法。

在一个示例中，电子设备还可包括通信接口403和总线410。其中，如图4所示，处理器401、存储器402、通信接口403通过总线410连接并完成相互间的通信。

通信接口403，主要用于实现本发明实施例中各模块、装置、单元和/或设备之间的通信。

总线410包括硬件、软件或两者，将电子设备的部件彼此耦接在一起。举例来说而非限制，总线可包括加速图形端口(AGP)或其他图形总线、增强工业标准架构(EISA)总线、前端总线(FSB)、超传输(HT)互连、工业标准架构(ISA)总线、无限带宽互连、低引脚数(LPC)总线、存储器总线、微信道架构(MCA)总线、外围组件互连(PCI)总线、PCI-Express(PCI-X)总线、串行高级技术附件(SATA)总线、视频电子标准协会局部(VLB)总线或其他合适的总线或者两个或更多个以上这些的组合。在合适的情况下，总线410可包括一个或多个总线。尽管本发明实施例描述和示出了特定的总线，但本发明考虑任何合适的总线或互连。

该电子设备可以执行本发明实施例中的接口自动扩展方法，从而实现结合图1和图2所示实施例描述的接口自动扩展方法。

另外，结合上述实施例中的接口自动扩展方法，本发明实施例可提供一种计算机存储介质来实现。该计算机存储介质上存储有计算机程序指令；该计算机程序指令被处理器执行时实现上述实施例中的任意一种接口自动扩展方法。

需要明确的是，本发明并不局限于上文所描述并在图中示出的特定配置和处理。为了简明起见，这里省略了对已知方法的详细描述。在上述实施例中，描述和示出了若干具体的步骤作为示例。但是，本发明的方法过程并不限于所描述和示出的具体步骤，本领域的技术人员可以在领会本发明的精神后，作出各种改变、修改和添加，或者改变步骤之间的顺序。

以上所述的结构框图中所示的功能块可以实现为硬件、软件、固件或者它们的组合。当以硬件方式实现时，其可以例如是电子电路、专用集成电路(ASIC)、适当的固件、插件、功能卡等等。当以软件方式实现时，本发明的元素是被用于执行所需任务的程序或者代码段。程序或者代码段可以存储在机器可读介质中，或者通过载波中携带的数据信号在传输介质或者通信链路上传送。“机器可读介质”可以包括能够存储或传输信息的任何介质。机器可读介质的例子包括电子电路、半导体存储器设备、ROM、闪存、可擦除ROM(EROM)、软盘、CD-ROM、光盘、硬盘、光纤介质、射频(RF)链路，等等。代码段可以经由诸如因特网、内联网等的计算机网络被下载。

还需要说明的是，本发明中提及的示例性实施例，基于一系列的步骤或者装置描述一些方法或系统。但是，本发明不局限于上述步骤的顺序，也就是说，可以按照实施例中提及的顺序执行步骤，也可以不同于实施例中的顺序，或者若干步骤同时执行。

以上所述，仅为本发明的具体实施方式，所属领域的技术人员可以清楚地了解到，为了描述的方便和简洁，上述描述的系统、模块和单元的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。应理解，本发明的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，可轻易想到各种等效的修改或替换，这些修改或替换都应涵盖在本发明的保护范围之内。

Claims (10)

1.一种接口自动扩展方法，其特征在于，所述方法包括：

获取用户输入的接口选择信息；

当所述接口选择信息为扩展接口信息时，根据所述接口选择信息从预设的参数配置库中确定接口扩展参数；

替换当前服务接口的接口参数为所述接口扩展参数，生成扩展服务接口。

2.根据权利要求1所述的方法，其特征在于，所述方法还包括：

当所述接口选择信息为新增接口信息时，接收用户输入的接口参数；

检验所述接口参数是否满足预设的参数属性；

当所述接口参数满足所述预设的参数属性时，生成目标接口。

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

当所述接口参数不满足所述预设的参数属性时，生成异常提示信息，以用于提示所述用户填写所述接口参数。

4.根据权利要求1-3任一项所述的方法，其特征在于，所述方法还包括：

根据所述接口扩展参数，生成调用样板代码，以用于目标系统进行接口调用。

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

生成所述扩展服务接口的接口文档，以用于向用户展示所述接口文档。

6.一种接口自动扩展装置，其特征在于，所述装置包括：

获取模块，用于获取接口选择信息；

确定模块，用于当所述接口选择信息为扩展接口信息时，根据所述接口选择信息从预设的参数配置库中确定接口扩展参数；

生成模块，用于替换当前服务接口的接口参数为所述接口扩展参数，生成扩展服务接口。

7.根据权利要求6所述的装置，其特征在于，所述装置还包括：

接收模块，用于当所述接口选择信息为新增接口信息时，接收用户输入的接口参数；

检验模块，用于检验所述接口参数是否满足预设的参数属性；

所述生成模块，还用于当所述接口参数满足所述预设的参数属性时，生成目标接口。

8.根据权利要求7所述的装置，其特征在于，所述装置还包括：

所述生成模块，还用于当所述接口参数不满足所述预设的参数属性时，生成异常提示信息，以用于提示所述用户填写所述接口参数。

9.一种电子设备，其特征在于，所述设备包括：处理器以及存储有计算机程序指令的存储器；

所述处理器执行所述计算机程序指令时实现如权利要求1-5任意一项所述的方法。

10.一种计算机存储介质，其特征在于，所述计算机存储介质上存储有计算机程序指令，所述计算机程序指令被处理器执行时实现如权利要求1-5任意一项所述的方法。

Images