CN112181537B

CN112181537B - 一种在计算机程序中调用api的方法及系统

Info

Publication number: CN112181537B
Application number: CN202011033179.2A
Authority: CN
Inventors: 朱领军
Original assignee: Shenzhen Jizhan Technology Co ltd
Current assignee: Shenzhen Jizhan Technology Co.,Ltd.
Priority date: 2020-09-27
Filing date: 2020-09-27
Publication date: 2021-11-19
Anticipated expiration: 2040-09-27
Also published as: CN112181537A

Abstract

本发明公开了一种在计算机程序中调用API的方法及系统，首先在预设页面填写API相关信息以及与API对应的测试脚本，所述测试脚本用于测试与之对应API的可用性以及性能，在审核、评估后，将API以及API相关信息、API对应的测试脚本添加到数据库中，提供给用户，并标识该API的性能等级，用户根据API相关信息调用该API。本发明便于用户快速Mashup一个应用，而且通过测试脚本定期测试API的可用性和性能，可以防止有些网站关闭后还在提供API，而用户调用该API却无法完成对应功能，而且进一步统一了不同网站提供的API，便于用户调用。

Description

一种在计算机程序中调用API的方法及系统

技术领域

本发明涉及计算机技术领域，更具体的说，涉及到在计算机程序中调用API，尤其是调用其他服务器API的方法及系统。

背景技术

随着互联网的发展，出现了大量网站，而且很多网站在某一方面具有优势，这些网站将自己的内容以暴露API接口的方式，供用户调用，例如百度地图、谷歌地图等提供了地图调用的API以及调用说明，用户只要参考文档说明，即可调用该服务。

不同的网站提供的内容不同，其暴露的API调用方法也有差别，为了以统一的格式提供服务，目前大量网站积极参考RESTfulAPI规范，进一步规范提供的API。而且为了便于用户查找API，世界上很多组织以爬虫或者半人工的方式提供网络服务搜索功能，并对网站提供的API分类，这样用户只需要根据自己网站功能的需要调用这些网站提供的API，就可以快速构建Mashup一个自己的网站，让用户专注于自己的业务。

以上的现有技术为用户提供了方便，但是也存在不少问题，例如：

1.RESTful API规范并非强制性规范，还有很多网站提供的API并不符合该规范，而且有些差异还很大，不便于用户在编程中调用；

2.A网站提供的API通常是以A的域名为前缀，B网站提供的API通常是以B网站的域名为前缀，在编程中，一会调用A网站的内容，一会调用B网站的内容，非常不利于后期维护；

3.如果A网站提供了某项服务，但是由于经营不善等原因，A网站无法再提供服务，再调用A网站的内容就会没有响应，但是用户并不知晓，严重影响用户体验。

发明内容

为了解决上述问题，本发明提供了一种在计算机程序中调用API的方法及系统。具体为：

一种在计算机程序中调用API的方法，包括以下步骤：

步骤1：在第一页面添加API以及API的相关信息、API对应的测试脚本；所述API的相关信息至少包括所述API的输入、输出参数的说明，以及所述API的名称、所述API的分类信息；所述测试脚本用于测试API的可用性以及性能，由服务器执行；

步骤2：在审核、评估后，将API、API标识信息、所述API的相关信息、API对应的测试脚本添加到数据库中，并依据测试脚本最近N次测试API得到的响应时间的平均值，标识该API的性能等级，N为大于1的整数；所述API标识信息用于唯一的标识该API；

步骤3：用户在第二页面查找API，通过预设的调用方法调用该API，所述预设的调用方法是以该API的标识信息、该API的输入参数、所述用户的账号、所述用户的密码作为参数进行调用的；

步骤4：中间服务方将预设的调用方法转化为对应API提供方要求的API调用方式，调用对应API，并将结果返回给用户。

所述测试脚本用于测试API的可用性以及性能，由服务器执行，具体为：

统计API最近M天调用次数，根据调用次数以及服务器的资源占用情况得到服务器执行测试脚本的周期；所述M为不小于1、且不大于4的整数。

所述依据测试脚本最近N次测试API得到的响应时间的平均值，标识该API的性能等级，具体包括：

统计最近N次测试API有响应的次数p以及对应的响应时间t_i，以及API无响应的次数q，平均响应时间为

根据以下公式得到API的性能等级：

其中，S表示PAPI的性能等级，其数值越小，表示该API的性能越好，p、q为正整数，1≤i≤p，p+q＝N。

所述步骤3具体为：当要调用用户查找到的API时，将要调用的API的标识信息、要调用的API的输入参数、所述用户的账号、所述用户的密码作为参数进行调用的，服务器对输入参数进行校验，并核对用户的账号、密码信息，根据API的标识信息查找数据库中与该API的标识信息对应的API，并利用所述输入参数作为该API的参数，将调用结果返回给用户，并对该用户的本次调用收取费用。

所述API标识信息为所述API的名称的Hash、MD5，或者所述API的Hash、MD5。

本发明还提供了一种在计算机程序中调用API的系统，包括以下模块：

添加模块，用于在第一页面添加API以及API的相关信息、API对应的测试脚本；所述API的相关信息至少包括所述API的输入、输出参数的说明，以及所述API的名称、所述API的分类信息；所述测试脚本用于测试API的可用性以及性能，由服务器执行；

审核模块，用于审核、评估添加模块添加的信息，将API、API标识信息、所述API的相关信息、API对应的测试脚本添加到数据库中，并依据测试脚本最近N次测试API得到的响应时间的平均值，标识该API的性能等级，N为大于1的整数；所述API标识信息用于唯一的标识该API；

调用模块，用于用户在第二页面查找API，通过预设的调用方法调用该API，所述预设的调用方法是以该API的标识信息、该API的输入参数、所述用户的账号、所述用户的密码作为参数进行调用的；

返回结果模块，中间服务方将预设的调用方法转化为对应API提供方要求的API调用方式，调用对应API，并将结果返回给用户。

根据以下公式得到API的性能等级：

调用模块具体用于：当要调用用户查找到的API时，将要调用的API的标识信息、要调用的API的输入参数、所述用户的账号、所述用户的密码作为参数进行调用的，服务器对输入参数进行校验，并核对用户的账号、密码信息，根据API的标识信息查找数据库中与该API的标识信息对应的API，并利用所述输入参数作为该API的参数，将调用结果返回给用户，并对该用户的本次调用收取费用。

本发明还提供了一种计算机系统，包括：一个或多个处理器；存储器，用于存储一个或多个程序，

其中，当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器执行上述所述的方法。

以及一种计算机可读存储介质，其上存储有可执行指令，该指令被处理器执行时使处理器实现上述所述的方法。

本发明采用服务提供方或者中间网站工作人员添加API相关信息到一个中间网站，并要求提交相关测试脚本，在中间网站工作人员审核后，新添加的API即可向其他用户提供，这些用户可以利用统一的调用方式调用这些API，而且由于定时执行测试脚本，可以定时对API进行评估，及时将不可用API删除，并提醒已经调用该不可用API的用户，其解决了现有技术中存在的调用格式不统一的问题，以及对API缺少后期维护的问题。

附图说明

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

图1为本发明实施例提供的网络结构图；

图2为本发明实施例提供的API调用方法的一种实现方式的流程图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

不同的服务提供方提供的API的格式有所不同，例如调用一个网站提供API的方法为：引入相关的库，在代码中根据文档的要求调用该ABC提供的API，当只调用一个或几个网站时，程序员还能记住这些调用，但是当调用几十、甚至几百个API时，由于不同服务提供方提供的API的库以及各自不同的调用规范，这就给后期代码的维护带来了很大的困难，严重违背了软件涉及中高内聚、低耦合的要求。

如图1所述，本发明提供的一种在计算机程序中调用API的系统，其中中间服务器中存储有多个服务提供方提供的API，用户通过中间服务器访问多个服务提供方提供的API。本发明提供的技术方案，是通过中间服务器屏蔽各个服务提供方提供的API的差异，程序开发人员只需要熟悉该中间服务方提供的服务即可，无需担心各个API规范，而且无需但是由于有些服务提供方中断服务的问题，而且可以视情况所需，中间服务方在有必要的时候向用户索取一定的中间服务费用，当然也可以免费维护API。

在一个实施方式中，有三个网站A、B、C向用户提供API服务，调用对应API的格式、库函数都不相同，例如有的使用大写、有的使用小写，而且很多带有对应网站的标识信息，例如域名，譬如getMap()、GetMap()，又或者AgetMap()、BGetMap()，亦或者http://api.A.com/getMap()、http://api.B.com/BGetMap、http://c.com/api/CgetMap()等；而且当A经营不善时，A提供的API的响应也会受到影响，为了统一格式以及对API进行评级，提供了以下方法：

首先，构建一个中间服务商平台，该中间服务商平台向用户提供API，所述API来自不同的网站，但经过加工在该中间服务商平台以相同的格式向用户提供；

网站A、B、C的工作人员，或者中间服务商平台的工作人员，在预设网页中填写网站A、B、C的API相关信息，同时，提交对应API的测试脚本，该测试脚本主要为了测试与该测试脚本对应的API的可用性以及该API的性能，在中间服务器或者与之相关的服务器中执行该测试脚本，即可监测API的可用性，当API不可用时，向中间服务商平台的工作人员发出警告，同时在中间服务商平台网站上标识该API性能低或者不可用；

由中间服务商平台审核、评估后，将API、API标识信息、所述API的相关信息、API对应的测试脚本添加到数据库中；

这样，用户在第二页面查找API，通过预设的调用方法即可调用该API。

在一个更具体的实施例中，还包括，统计API最近M天调用次数，根据调用次数以及服务器的资源占用情况得到服务器执行测试脚本的周期；所述M为不小于1、且不大于4的整数。当一个API在一定时间内，调用次数越多，说明该API越热门，也说明说了如果该API停止服务造成的影响更大，因此，预设时间内调用测试越多，测试脚本的周期越小；同时，也考虑了服务器的性能，当在中间服务器中执行时，如果服务器的资源占用率高，则该服务器处于繁忙状态，则要降低测试脚本的周期；需要说明的时，如果测试脚本在于中间服务器平台相关的其他服务器中执行，则无需考虑服务器的性能。

根据调用次数和服务器的资源占用情况确定测试脚本的执行周期有多种方式，包括但不限于利用权值法、通过机器学习等方式。

在一个更具体的实施例中，还包括，所述依据测试脚本最近N次测试API得到的响应时间的平均值，标识该API的性能等级，具体包括：

根据以下公式得到API的性能等级：

在一个实施例中，中间服务方提供API的维护，API服务提供方实际提供服务，当用户需要调用API时，用户只需要登录中间服务方提供的平台，根据API的分类，查找对应的API，在编码中，用户引入中间服务器平台统一的库函数或者jar包，在调用第三方API时，只需要按照该中间服务方提供的文档要求，既可以完成调用。

为了便于理解，下面提供一个更为详细的实施例。

服务提供方或者中间服务方的工作人员在预设页面填写API的相关信息，如下表所示：

提供API的官网	API名称
		API输入输出	调用该API需要引入的库函数或jar包
API的分类	API的关键词
		API的调用方法	测试脚本

所应理解的是，以上所述仅为本发明的具体实施例而已，并不用于限定本发明的保护范围。当然还可以包括每调用一次的收费信息。

用户提交之后，中间服务方的工作人员需要进一步审查、核对上述信息，并对测试脚本进行测试，并检测该测试脚本是否含有病毒，在测试完全通过后，将该API开放给公众。

在中间服务方提供API的同时，还会利用测试脚本定期对API进行测试，防止API停止服务给用户带来的损失；并及时更新API的性能等相关信息，用户在浏览API时可以看到API的性能信息，便于用户挑选API。

在一个实施例中，当用户在代码中调用API时，只要使用中间服务方提供的方法，例如XXXserviceProvider(parameter1,parameter2,paremter3,paremter4,paremter5,…)，其中，parameter1表示API服务提供方提供的服务，parameter2表示API服务提供方提供的API的参数，parameter3表示要调用该服务的用户的账号信息，parameter5表示要调用该服务的用户的密码，以上只是示例，还可以包括其他信息；。

其中parameter1是API名称或者该API的地址信息的hash或者MD5值，例如https://api.A.com/xxx/，中间服务提供方维护一份对应的关系表，通过所述hash或者MD5值可以唯一确定要调用的API，由中间服务提供方完成中间转化过程，也即将上述调用转化为API提供方要求的格式，并在调用后将结果返回给调用该API的用户。

在一个实施例中，中间服务方还会对用户的账号和密码进行核对，只有通过认证的用户才能调用该服务。

调用模块，用于用户在第二页面查找API，通过预设的调用方法调用该API，所述预设的调用方法是以该API的标识信息、该API的输入参数、所述用户的账号、所述用户的密码作为参数进行调用的。

根据以下公式得到API的性能等级：

本领域内的技术人员应明白，本发明的实施例可提供为方法、系统、或计算机程序产品。因此，本发明可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本发明可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器、CD-ROM、光学存储器等)上实施的计算机程序产品的形式。

以上所述的具体实施例，对本发明的目的、技术方案和有益效果进行了进一步详细说明，所应理解的是，以上所述仅为本发明的具体实施例而已，并不用于限定本发明的保护范围，凡在本发明的精神和原则之内，所做的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims

1.一种在计算机程序中调用API的方法，其特征在于，包括以下步骤：

步骤1：在第一页面添加API以及API的相关信息、API对应的测试脚本；所述API的相关信息至少包括所述API的输入、输出参数的说明，以及所述API的名称、所述API的分类信息；所述测试脚本用于测试API的可用性以及性能，由服务器周期执行，对于不同的API，服务器执行测试脚本的周期不同；

步骤3：用户在第二页面查找API，通过预设的调用方法调用该API，所述预设的调用方法是以该API的标识信息、该API的输入参数、所述用户的账号、所述用户的密码作为方法参数进行调用的；

步骤4：中间服务方将预设的调用方法转化为对应API提供方要求的API调用方式，调用对应API，并将结果返回给用户；

根据以下公式得到API的性能等级：

其中，S表示API的性能等级，其数值越小，表示该API的性能越好，p、q为正整数，1≤i≤p，p+q＝N。

2.根据权利要求1所述的方法，其特征在于，所述测试脚本用于测试API的可用性以及性能，由服务器执行，具体为：

3.根据权利要求1至2任一所述的方法，其特征在于，所述步骤3具体为：

当要调用用户查找到的API时，将要调用的API的标识信息、要调用的API的输入参数、所述用户的账号、所述用户的密码作为参数进行调用的，服务器对输入参数进行校验，并核对用户的账号、密码信息，根据API的标识信息查找数据库中与该API的标识信息对应的API，并利用所述输入参数作为该API的参数，将调用结果返回给用户，并对该用户的本次调用收取费用。

4.一种在计算机程序中调用API的系统，其特征在于，包括以下模块：

添加模块，用于在第一页面添加API以及API的相关信息、API对应的测试脚本；所述API的相关信息至少包括所述API的输入、输出参数的说明，以及所述API的名称、所述API的分类信息；所述测试脚本用于测试API的可用性以及性能，由服务器周期执行，对于不同的API，服务器执行测试脚本的周期不同；

调用模块，用于用户在第二页面查找API，通过预设的调用方法调用该API，所述预设的调用方法是以该API的标识信息、该API的输入参数、所述用户的账号、所述用户的密码作为方法参数进行调用的；

返回结果模块，中间服务方将预设的调用方法转化为对应API提供方要求的API调用方式，调用对应API，并将结果返回给用户；

根据以下公式得到API的性能等级：

5.根据权利要求4所述的系统，其特征在于，所述测试脚本用于测试API的可用性以及性能，由服务器执行，具体为：

6.根据权利要求4至5任一所述的系统，其特征在于，调用模块具体用于：

7.一种计算机可读存储介质，其上存储有可执行指令，该指令被处理器执行时使处理器实现权利要求1至3中任一项所述的方法。