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

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

A method and system of real-time acquiring interface update information

【技术实现步骤摘要】
一种实时获取接口更新信息的方法及系统
本专利技术涉及计算机技术和网络
，尤其涉及一种实时获取接口更新信息的方法及系统。
技术介绍
在计算机软件开发过程中，经常需要调用各种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.一种实时获取接口更新信息的方法，其特征在于，包括：/n接口函数提供方在本地提供、或者在本地提供并自动发送包含所述接口更新信息的接口更新文件；/n接口函数调用方主动从远程获取、或者自动从远程接收所述接口更新文件，从而获取所述接口更新信息，/n其中，所述接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。/n

【技术特征摘要】
1.一种实时获取接口更新信息的方法，其特征在于，包括：
接口函数提供方在本地提供、或者在本地提供并自动发送包含所述接口更新信息的接口更新文件；
接口函数调用方主动从远程获取、或者自动从远程接收所述接口更新文件，从而获取所述接口更新信息，
其中，所述接口更新信息包括接口域名、域名下的资源路径、接口函数的输入参数、接口函数的输出参数。


2.如权利要求1所述的实时获取接口更新信息的方法，其特征在于，还包括：
所述接口函数调用方使用中间件来主动从远程获取、或者自动从远程接收所述接口更新文件，
其中，所述接口函数提供方是后端服务器程序开发方，所述接口函数调用方是其他后端服务器开发方和/或前端应用程序开发方，所述接口更新文件包括下列格式的文件中的至少一种：JSON、XML、自定义格式。


3.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：
所述接口函数调用方基于SOCKET长连接来主动从远程获取、或者自动从远程接收所述接口更新文件。


4.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：
首次时，所述接口函数提供方在本地提供、或者在本地提供并自动发送包含全部初始接口信息的初始接口配置文件，非首次时，所述接口函数提供方在本地提供、或者在本地提供并自动发送包含接口增量更新信息的接口更新文件；
首次时，所述接口函数调用方主动从远程获取、或者自动从远程接收所述初始接口配置文件，非首次时，所述接口函数调用方主动从远程获取、或者自动从远程接收所述接口更新文件。


5.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：
当所述接口更新信息仅仅涉及参数名称更新时，所述接口函数调用方根据所述接口更新信息中的新参数名称与旧参数名称之间的映射关系，自动获取所述新参数名称所对应的所述旧参数名称所匹配的具体参数值。


6.如权利要求1或2所述的实时获取接口更新信息的方法，其特征在于，还包括：
当所述接口更新文件更新时，自动发送邮件和/或即时通讯消息通知所述接口函数调用方的系统管理员。


7.一种实时获取接口更新信息的系统，...

【专利技术属性】
技术研发人员：郭泉宁，苗辉，
申请(专利权)人：厦门白山耘科技有限公司，
类型：发明
国别省市：福建;35