CN111104135A - 一种实时获取接口更新信息的方法及系统 - Google Patents

Abstract

本发明公开了一种实时获取接口更新信息的方法及系统。所公开的方法包括：接口函数提供方在本地提供、或者在本地提供并自动发送包含接口更新信息的接口更新文件；接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件，从而获取接口更新信息，其中，接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。所公开的技术方案能够基于完善的通知机制，将API提供方针对API函数做出的变动及时地通知给API调用方，无需耗费较多的人力。

Description

一种实时获取接口更新信息的方法及系统

技术领域

本发明涉及计算机技术和网络技术领域，尤其涉及一种实时获取接口更新信息的方法及系统。

背景技术

在计算机软件开发过程中，经常需要调用各种API函数，然而，随着用户需求的变更，这些API函数的接口参数(例如，参数类型、参数个数等)可能会发生变化，从而需要在调用这些API函数时做出相应地修改。在现有技术中，这一过程通常是由工程师阅读接口变更文档，并且对应地修改API函数调用所涉及的源代码来实现的。

例如，在网络应用程序开发过程中，会存在前端和后端之间的各种API对接、后端和后端之间的各种API对接。在对接的过程中，API提供方和API调用方定好交互的数据格式，按照双方定好的格式(请求的格式和返回的格式)就可以进行互通了。可是一旦接口提供方的接口的参数发生变更之后，调用方如果未能及时收到通知，那么按照原有的格式进行请求的时候，必然会报错，而且，即使是调用方被通知了，也基本上都是通过人工方式进行确认和修改，开发效率低且结果不准确。而且，接口调用方也不能及时地接收到接口提供方的接口变更信息。

因此，现有技术的上述技术方案具有以下缺点：

1、当API提供方的某个接口的某个属性发生了变化时，API调用方是后知后觉的，从而导致API调用方调用接口时会出现报错、或者会出现通过该API函数所返回的数据不符合预期结果的情况。

2、API提供方向API调用方所提供的API函数变更信息可能不完全。在这种情况下，即使API调用方获知接口发生了变动，也不清楚是什么接口的哪个值发生了改变，API调用方还是需要再次同API提供方确认接口变动的细节。

3、(例如，符合RESTful协议的)API函数的请求格式和返回格式都是从API提供方所提供的接口参数说明文档中人工提取出来的，容易产生错误。

4、由于不能进行自动检测，所以需要持续地以人工方式来核对API提供方所提供的用于记录接口格式的文档，以确定其中记载的接口调用方式和返回数据是否发生了改变，在这种情况下，API调用方得到的具体更新信息具有很大的延迟。

为了解决上述技术问题，需要提出新的技术方案。

发明内容

根据本发明的实时获取接口更新信息的方法，包括：

接口函数提供方在本地提供、或者在本地提供并自动发送包含接口更新信息的接口更新文件；

接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件，从而获取接口更新信息，

其中，接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。

根据本发明的实时获取接口更新信息的方法，还包括：

接口函数调用方使用中间件来主动从远程获取、或者自动从远程接收接口更新文件，

其中，接口函数提供方是后端服务器程序开发方，接口函数调用方是其他后端服务器开发方和/或前端应用程序开发方，接口更新文件包括下列格式的文件中的至少一种：JSON、XML、自定义格式。

根据本发明的实时获取接口更新信息的方法，还包括：

接口函数调用方基于SOCKET长连接来主动从远程获取、或者自动从远程接收接口更新文件。

根据本发明的实时获取接口更新信息的方法，还包括：

首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含全部初始接口信息的初始接口配置文件，非首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含接口增量更新信息的接口更新文件；

首次时，接口函数调用方主动从远程获取、或者自动从远程接收初始接口配置文件，非首次时，接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件。

根据本发明的实时获取接口更新信息的方法，还包括：

当接口更新信息仅仅涉及参数名称更新时，接口函数调用方根据接口更新信息中的新参数名称与旧参数名称之间的映射关系，自动获取新参数名称所对应的旧参数名称所匹配的具体参数值。

根据本发明的实时获取接口更新信息的方法，还包括：

当接口更新文件更新时，自动发送邮件和/或即时通讯消息通知接口函数调用方的系统管理员。

根据本发明的实时获取接口更新信息的系统，包括：

接口更新文件生成装置，用于接口函数提供方在本地生成、或者在本地提供并自动发送包含接口更新信息的接口更新文件；

接口更新文件获取装置，用于接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件，从而获取接口更新信息，

其中，接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。

根据本发明的实时获取接口更新信息的系统，其接口更新文件获取装置包括中间件：

接口函数调用方使用中间件来主动从远程获取、或者自动从远程接收接口更新文件，

其中，接口函数提供方是后端服务器程序开发方，接口函数调用方是其他后端服务器开发方和/或前端应用程序开发方，接口更新文件包括下列格式的文件中的至少一种：JSON、XML、自定义格式。

根据本发明的实时获取接口更新信息的系统，其接口更新文件获取装置还用于：

接口函数调用方基于SOCKET长连接来主动从远程获取、或者自动从远程接收接口更新文件。

根据本发明的实时获取接口更新信息的系统，其接口更新文件生成装置还用于：

首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含全部初始接口信息的初始接口配置文件，非首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含接口增量更新信息的接口更新文件；和/或

当接口更新文件更新时，自动发送邮件和/或即时通讯消息通知接口函数调用方的系统管理员，

接口更新文件获取装置还用于：

首次时，接口函数调用方主动从远程获取、或者自动从远程接收初始接口配置文件，非首次时，接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件；和/或

当接口更新信息仅仅涉及参数名称更新时，接口函数调用方根据接口更新信息中的新参数名称与旧参数名称之间的映射关系，自动获取新参数名称所对应的旧参数名称所匹配的具体参数值；和/或

当接口更新文件更新时，自动发送邮件和/或即时通讯消息通知接口函数调用方的系统管理员。

根据本发明的上述技术方案，能够基于完善的通知机制，将API提供方针对API函数做出的变动及时地通知给API调用方，无需耗费较多的人力。

附图说明

并入到说明书中并且构成说明书的一部分的附图示出了本发明的实施例，并且与相关的文字描述一起用于解释本发明的原理。在这些附图中，类似的附图标记用于表示类似的要素。下面描述中的附图是本发明的一些实施例，而不是全部实施例。对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，可以根据这些附图获得其他的附图。

图1示例性地示出了根据本发明的实时获取接口更新信息的方法的示意流程图。

图2示例性地示出了根据本发明的实时获取接口更新信息的系统的示意框图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明的一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。需要说明的是，在不冲突的情况下，本申请中的实施例及实施例中的特征可以相互任意组合。

图1示例性地示出了根据本发明的实时获取接口更新信息的方法的示意流程图。

如图1的实线框所示，根据本发明的实时获取接口更新信息的方法，包括：

步骤S102：接口函数提供方在本地提供、或者在本地提供并自动发送包含接口更新信息的接口更新文件；

步骤S104：接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件，从而获取接口更新信息，

其中，接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。

可选地，如图1的虚线框所示，根据本发明的实时获取接口更新信息的方法，还包括：

步骤S106：接口函数调用方使用中间件来主动从远程获取、或者自动从远程接收接口更新文件，

其中，接口函数提供方是后端服务器程序开发方，接口函数调用方是其他后端服务器开发方和/或前端应用程序开发方，接口更新文件包括下列格式的文件中的至少一种：JSON、XML、自定义格式。

可选地，如图1的虚线框所示，根据本发明的实时获取接口更新信息的方法，还包括：

步骤S108：接口函数调用方基于SOCKET长连接来主动从远程获取、或者自动从远程接收接口更新文件。

可选地，如图1的虚线框所示，根据本发明的实时获取接口更新信息的方法，还包括：

步骤S110：首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含全部初始接口信息的初始接口配置文件，非首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含接口增量更新信息的接口更新文件；

步骤S112：首次时，接口函数调用方主动从远程获取、或者自动从远程接收初始接口配置文件，非首次时，接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件。

可选地，如图1的虚线框所示，根据本发明的实时获取接口更新信息的方法，还包括：

步骤S114：当接口更新信息仅仅涉及参数名称更新时，接口函数调用方根据接口更新信息中的新参数名称与旧参数名称之间的映射关系，自动获取新参数名称所对应的旧参数名称所匹配的具体参数值。

可选地，如图1的虚线框所示，根据本发明的实时获取接口更新信息的方法，还包括：

步骤S116：当接口更新文件更新时，自动发送邮件和/或即时通讯消息通知接口函数调用方的系统管理员。

为了使本领域技术人员更清楚地理解根据本发明的上述技术方案，下面将结合一个具体实施例进行说明。

该示例实施例可以应用于网络应用程序，并且可以采用以下具体步骤来实时获取接口更新信息：

1、在前端和后端之间搭建一个类似平台的中间层(即，对应于上述步骤S106中的中间件)。第一次中间层会发起一个API请求，先读取后端维护的一份接口列表(即，上述接口更新信息)，例如，对应于同一个接口域名、接口列表包含path(即，上述域名下的资源路径，对应于具体的接口名称)、每个接口的输入设置参数或输入查询参数(即，上述接口函数的输入参数)、每个接口返回的数据格式(即，上述接口函数的输出参数)。可选地，中间层拿到数据后，以后端接口的域名新建一个文件夹(即，本地存储的文件)，然后在文件夹中，在根据path的名称(对应于具体的接口名称)新建一个JSON文件(即，JSON格式的接口更新文件)，每个接口存一份JSON文件，JSON的文件名是接口的名称，而JSON里面内容就是接口返回的数据格式。

2、中间层向后端发起一个SOCKET的长连接(即，对应于上述步骤S108)。中间层和后端SOCKET长连接中传输的数据格式是JSON，只要是后端的接口数据发生变动，后端主动将变动数据传到中间层，传输的数据中包含的数据格式，{域名:‘http://www.API.com’,path:‘/a/b’,oldAttr:‘old_name’,…,newAttr:‘new_name’,…}，其中，oldAttr和newAttr分别包括一一对应的各种旧(新)属性(即，上述接口函数的输入参数、接口函数的输出参数)，例如：name、age、sex等。

域名表示对应接口的域名，path表示同一个接口域名下的具体路径，oldAttr表示与path路径对应的接口中的某个旧属性的名称，newAttr表示path路径所对应的接口中的(与oldAttr对应的)新属性的名称。

3、对应于上述步骤S114，中间层拿到JSON数据之后，基于上述JSON格式的数据，例如，可以根据域名找到磁盘中对应的文件夹，然后根据path找到文件夹中存放的具体JSON文件，接着根据oldAttr的值匹配JSON中哪个属性发生了变化，再把oldAttr的值替换为newAttr的值(即，上述具体参数值)。

4、对应于上述步骤S116，例如，当中间层检测到远程JSON文件发生更改时，可以调用发邮件的工具发送一封邮件给(接口函数)调用方，调用方指的是在中间层注册的一个成员，成员在注册的时候会有必填的两个信息，(即时通讯)用户名和邮箱地址。

该示例实施例通过新增中间层，实现了前后端API修改的实时通知，自动修正旧属性(即，自动将新属性匹配至旧属性)，确保前后端API的连接通畅无误，减少了人工操作。

图2示例性地示出了根据本发明的实时获取接口更新信息的系统200的示意框图。

如图2所示，根据本发明的实时获取接口更新信息的系统200，包括：

接口更新文件生成装置201，用于接口函数提供方在本地生成、或者在本地提供并自动发送包含接口更新信息的接口更新文件；

接口更新文件获取装置203，用于接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件，从而获取接口更新信息，

其中，接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。

可选地，接口更新文件获取装置203包括中间件：

接口函数调用方使用中间件来主动从远程获取、或者自动从远程接收接口更新文件，

其中，接口函数提供方是后端服务器程序开发方，接口函数调用方是其他后端服务器开发方和/或前端应用程序开发方，接口更新文件包括下列格式的文件中的至少一种：JSON、XML、自定义格式。

可选地，接口更新文件获取装置203还用于：

接口函数调用方基于SOCKET长连接来主动从远程获取、或者自动从远程接收接口更新文件。

可选地，接口更新文件生成装置201还用于：

首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含全部初始接口信息的初始接口配置文件，非首次时，接口函数提供方在本地提供、或者在本地提供并自动发送包含接口增量更新信息的接口更新文件；和/或

当接口更新文件更新时，自动发送邮件和/或即时通讯消息通知接口函数调用方的系统管理员，

接口更新文件获取装置203还用于：

首次时，接口函数调用方主动从远程获取、或者自动从远程接收初始接口配置文件，非首次时，接口函数调用方主动从远程获取、或者自动从远程接收接口更新文件；和/或

当接口更新信息仅仅涉及参数名称更新时，接口函数调用方根据接口更新信息中的新参数名称与旧参数名称之间的映射关系，自动获取新参数名称所对应的旧参数名称所匹配的具体参数值；和/或

当接口更新文件更新时，自动发送邮件和/或即时通讯消息通知接口函数调用方的系统管理员。

根据本发明的上述技术方案，具有以下优点：

1、能够基于完善的通知机制，将API提供方针对API函数做出的变动及时地通知给API调用方，无需耗费较多的人力。

2、能够通过文件的方式来准确地提供关于接口变动的完整信息(例如，接口名称、接口属性等)。

3、例如，能够通过前端和后端之间架设的中间层/中间件，与后端建立SOCKET长连接，当后端接口发生变动的时候就通知中间层，并自动做改动，避免了人为错误。

4、例如，可以通过中间层来实时监听接口列表是否发生变动、实时对接口列表尽心维护，一旦有变动就会通过邮件或者即时通讯发送通知消息，实现了接口变更的实时通知。

上面描述的内容可以单独地或者以各种方式组合起来实施，而这些变型方式都在本发明的保护范围之内。

本领域普通技术人员可以理解，上文中所公开方法中的全部或某些步骤、系统、装置中的功能模块/单元可以被实施为软件、固件、硬件及其适当的组合。在硬件实施方式中，在以上描述中提及的功能模块/单元之间的划分不一定对应于物理组件的划分；例如，一个物理组件可以具有多个功能，或者一个功能或步骤可以由若干物理组件合作执行。某些组件或所有组件可以被实施为由处理器，如数字信号处理器或微处理器执行的软件，或者被实施为硬件，或者被实施为集成电路，如专用集成电路。这样的软件可以分布在计算机可读介质上，计算机可读介质可以包括计算机存储介质(或非暂时性介质)和通信介质(或暂时性介质)。如本领域普通技术人员公知的，术语计算机存储介质包括在用于存储信息(诸如计算机可读指令、数据结构、程序模块或其他数据)的任何方法或技术中实施的易失性和非易失性、可移除和不可移除介质。计算机存储介质包括但不限于RAM、ROM、EEPROM、闪存或其他存储器技术、CD-ROM、数字多功能盘(DVD)或其他光盘存储、磁盒、磁带、磁盘存储或其他磁存储装置、或者可以用于存储期望的信息并且可以被计算机访问的任何其他的介质。此外，本领域普通技术人员公知的是，通信介质通常包含计算机可读指令、数据结构、程序模块或者诸如载波或其他传输机制之类的调制数据信号中的其他数据，并且可包括任何信息递送介质。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制。尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例的技术方案的精神和范围。

Claims (10)

1.一种实时获取接口更新信息的方法，其特征在于，包括：

接口函数提供方在本地提供、或者在本地提供并自动发送包含所述接口更新信息的接口更新文件；

接口函数调用方主动从远程获取、或者自动从远程接收所述接口更新文件，从而获取所述接口更新信息，

其中，所述接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。

2.如权利要求1所述的实时获取接口更新信息的方法，其特征在于，还包括：

所述接口函数调用方使用中间件来主动从远程获取、或者自动从远程接收所述接口更新文件，

其中，所述接口函数提供方是后端服务器程序开发方，所述接口函数调用方是其他后端服务器开发方和/或前端应用程序开发方，所述接口更新文件包括下列格式的文件中的至少一种：JSON、XML、自定义格式。

3.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：

所述接口函数调用方基于SOCKET长连接来主动从远程获取、或者自动从远程接收所述接口更新文件。

4.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：

首次时，所述接口函数提供方在本地提供、或者在本地提供并自动发送包含全部初始接口信息的初始接口配置文件，非首次时，所述接口函数提供方在本地提供、或者在本地提供并自动发送包含接口增量更新信息的接口更新文件；

首次时，所述接口函数调用方主动从远程获取、或者自动从远程接收所述初始接口配置文件，非首次时，所述接口函数调用方主动从远程获取、或者自动从远程接收所述接口更新文件。

5.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：

当所述接口更新信息仅仅涉及参数名称更新时，所述接口函数调用方根据所述接口更新信息中的新参数名称与旧参数名称之间的映射关系，自动获取所述新参数名称所对应的所述旧参数名称所匹配的具体参数值。

6.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：

当所述接口更新文件更新时，自动发送邮件和/或即时通讯消息通知所述接口函数调用方的系统管理员。

7.一种实时获取接口更新信息的系统，其特征在于，包括：

接口更新文件生成装置，用于接口函数提供方在本地生成、或者在本地提供并自动发送包含所述接口更新信息的接口更新文件；

接口更新文件获取装置，用于接口函数调用方主动从远程获取、或者自动从远程接收所述接口更新文件，从而获取所述接口更新信息，

其中，所述接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。

8.如权利要求7所述的实时获取接口更新信息的系统，其特征在于，所述接口更新文件获取装置包括中间件：

所述接口函数调用方使用所述中间件来主动从远程获取、或者自动从远程接收所述接口更新文件，

其中，所述接口函数提供方是后端服务器程序开发方，所述接口函数调用方是其他后端服务器开发方和/或前端应用程序开发方，所述接口更新文件包括下列格式的文件中的至少一种：JSON、XML、自定义格式。

9.如权利要求7或8所述的实时获取接口更新信息的系统，其特征在于，所述接口更新文件获取装置还用于：

所述接口函数调用方基于SOCKET长连接来主动从远程获取、或者自动从远程接收所述接口更新文件。

10.如权利要求7或8所述的实时获取接口更新信息的系统，其特征在于，所述接口更新文件生成装置还用于：

首次时，所述接口函数提供方在本地提供、或者在本地提供并自动发送包含全部初始接口信息的初始接口配置文件，非首次时，所述接口函数提供方在本地提供、或者在本地提供并自动发送包含接口增量更新信息的接口更新文件；和/或

当所述接口更新文件更新时，自动发送邮件和/或即时通讯消息通知所述接口函数调用方的系统管理员，

所述接口更新文件获取装置还用于：

首次时，所述接口函数调用方主动从远程获取、或者自动从远程接收所述初始接口配置文件，非首次时，所述接口函数调用方主动从远程获取、或者自动从远程接收所述接口更新文件；和/或

当所述接口更新信息仅仅涉及参数名称更新时，所述接口函数调用方根据所述接口更新信息中的新参数名称与旧参数名称之间的映射关系，自动获取所述新参数名称所对应的所述旧参数名称所匹配的具体参数值；和/或

当所述接口更新文件更新时，自动发送邮件和/或即时通讯消息通知所述接口函数调用方的系统管理员。

Images