CN110716743A - 一种适合多方协作开发的聚合api开发方法及系统 - Google Patents

Abstract

本发明公开了一种适合多方协作开发的聚合API开发方法及系统，涉及API（Application Programming Interface应用程序编程接口)接口领域。所述方法包括：S1、创建聚合API公共代码库；S2、多方协作开发对接开放API平台的代码库，一个对接开放API平台的代码库关联一个开放API平台；S3、利用聚合API公共代码库和对接开放API平台的代码库，设计聚合API系统，包括聚合API系统客户端与聚合API系统服务器；S4、第三方开发者使用聚合API系统客户端配置开发参数；S5、聚合API系统服务器处理响应第三方应用的API请求。

Description

一种适合多方协作开发的聚合API开发方法及系统

技术领域

本发明涉及API（Application Programming Interface应用程序编程接口）接口领域，尤其涉及一种适合多方协作开发的聚合API开发方法及系统。

背景技术

开放API平台，在互联网中，把网站或计算机应用系统的服务封装成一系列计算机易识别的数据接口开放出去，供第三方开发者使用，这种行为就叫做开放 API，提供开放API的平台本身就被称为开放API平台。2010年，百度在其开放平台大会上宣布，建立开放API平台，随后，新浪、腾讯、淘宝等也建立了开放API平台。可以说开放API是互联网的趋势。

有时候，第三方应用原本使用的是网站A提供的开放API平台，但是由于第三方开发者对网站A的服务不满意或者其他原因，需要更换网站B提供的开放API平台（ 常发生于手机短信等开放API平台）。这时，第三方开发者通常需要与网站B提供的开放API平台从头开始对接。

有时候，第三方开发者的应用原本仅使用网站A提供的开放API平台 ，但是由于经营需要，可能在原有对接网站A的基础上增加使用网站B提供的开放API平台（常发生于电子商务等，比如需要增加新的支付方式）。新的开放API平台的接入不仅对接需要工作量，甚至这种对接可能会影响到系统的稳定运行。

发明内容

（一）技术问题

本发明要解决的技术问题是：创建一个聚合API系统，减少第三方开发者对接开放API平台的工作量，使其只需要接入一次聚合API系统，便可实现多个开放API平台的对接，替换开放API平台的服务商的时候，减少第三方开发者应用代码的调整；另外为了这种聚合API系统能更加方便的扩展新的开放API平台，这种聚合API系统的研发方法，还要适合多方协作完成开放API平台对接。

（二）技术方案

为解决上述技术问题，本发明提供了一种适合多方协作开发的聚合API开发方法及系统，其特征在于，包括以下步骤：

S1、创建聚合API公共代码库。它的作用包括：处理响应API请求的逻辑；定义对接开放API平台的代码库应实现的接口Interface；提供生成公共代码库与对接开放API平台的代码库的映射关系的方法；

所述响应API请求的逻辑的具体流程为：聚合API公共代码库的方法被系统聚合API系统调用，使用公共代码库与对接开放API平台的代码库的映射关系，调用对接开放API平台的代码库，获得开放API平台的响应结果，格式化响应结果，返回聚合API系统代码的逻辑；

所述对接开放API平台的代码库应实现的接口Interface，是聚合API公共代码库规定对接开放API的方法需要具体实现的方法，具体特征为：使用面向对象程序设计(ObjectOriented Programming)方法，为每个对接开放API平台的代码库定义相应的接口Interface，每个所定义的接口Interface都有两个基本的方法，一个方法返回这个接口Interface具体实现类支持哪种API请求的关键字段，没有参数，返回值是关键字段列表；另一个方法是被公共代码库调用的用于向开放API平台发起请求的方法，这个方法的参数类型由公共代码库规定，这个方法的返回值也是由公共代码库规定的固定类型；对接开放API平台的代码按照公共代码库的规定解析方法接收到的参数，向开放API平台发起请求，再将开放API平台的响应值，格式化为公共代码库规定的返回值类型；

所述生成公共代码库与对接开放API平台的代码库的映射关系的方法，具体流程为：遍历对接开放API平台代码库的目录下的所有文件，检查所遍历的文件是否是实现对接开放API平台的代码库应实现的接口Interface的具体实现类，将检查匹配到的结果按以下格式保存为json文件：[{接口名Interface1:[{关键字段值1: 具体实现类1},{关键字段值2:具体实现类2}, ..., {关键字段值n: 具体实现类n}]},{接口名Interface2:[{关键字段值1: 具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]},...,{接口名Interfacen:[{关键字段值1: 具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]}]，接口名Interface就是公共代码库定义的对接开放API平台的代码库应实现的接口Interface，关键字段值就是实现了接口名Interface的类返回的它所支持的API请求的关键字段，具体实现类就是实现了接口名Interface的类的名称；

S2、多方协作开发对接开放API平台的代码库，用于步骤S1中所述聚合API公共代码库处理响应API请求的逻辑时调用，它需要实现步骤S1所述，对接开放API平台的代码库应实现的接口Interface，一个对接开放API平台的代码库关联一个开放API平台，因为对接开放API平台的代码库之间没有依赖性，所以多个开发者可以分别负责关联开放API平台的对接开放API平台的代码库，对接开放API平台的代码库处理请求方法的流程为，被公共代码库调用，按公共代码库规定的输入参数类型，解析参数并生成请求开放API平台的参数，向开放API平台发起请求，将开放API平台的响应值格式化为公共代码库规定的返回值类型，格式化后的响应值返回公共代码库的代码逻辑；

S3、利用聚合API公共代码库和对接开放API平台的代码库，设计聚合API系统，包括聚合API系统客户端与聚合API系统服务器；

S4、第三方开发者使用聚合API系统客户端配置开发者应用；

所述步骤S4的具体为：

S41、使用聚合API系统客户端，注册第三方开发者帐号；

S42、使用第三方开发者帐号登陆聚合API系统客户端；

S43、创建开发者应用，它含有两个关键信息，唯一标识和秘钥，唯一标识别用于聚合API系统服务器收到第三方应用API请求时，从聚合API系统服务器获取第三方开发者在聚合API系统设置的相关配置信息，秘钥用于第三方开发者请求之前生成签名，以及服务器在收到第三方应用请求时验证签名；

S44、为S43所述开发者应用配置开发API平台相关参数，这些参数时对接开放API平台的代码库需要使用的环境变量；

S45，第三方开发者还可以通过聚合API系统客户端查看聚合API系统服务器处理第三方应用API请求的日志，具体为，聚合API系统的服务器收到第三方应用的请求，会将这次请求的参数和响应结果保存在数据库中，聚合API系统客户端会列出所有第三方应用的请求信息；

S5、聚合API系统服务器处理响应第三方应用的API请求；

所述步骤S5的具体为：

S51、聚合API系统服务器收到第三方应用使用HTTP协议发起的API请求，提取代表对接应用的唯一标识的请求参数，这个唯一标识如步骤S43所述；

S52、根据S51所述唯一标识，从数据库中读取对接应用的配置信息，这个配置信息如步骤S44所述；

S53、从S52所述配置信息中提取秘钥，校验请求参数的签名是否有效，这个秘钥如步骤S43所述；

S54、从S52所述配置信息中，提取开放API平台相关的配置信息，根据对接开放API平台的代码库的要求，将开放API平台相关的配置信息，设置在程序运行的环境变量中；

S55、调用公共代码库中处理该请求的方法，具体特征为，提取接收到的请求中代表接口名称的请求参数，接口名称的参数值，是一个能按照特定规则，解析成应该被调用的公共代码库中处理该请求的文件的文件路径的值，获得文件路径，然后调用规定的方法；

S56、格式化公共代码库响应的结果，并响应第三方应用的API请求。

（三）有益效果

与现有技术相比，本发明的优点在于：

（1）本发明提供一种聚合API系统，第三方开发者应用只需要对接这个聚合API系统，就可以实现多个开放API平台的对接，明显降低研发成本；

（2）本发明提供一种聚合API系统，第三方开发者应用接入这个聚合API系统后，如果需要变换开放API平台的服务商，仅需要通过聚合API系统客户端配置即可，提高工作效率的同时又从一定程度上保证系统的稳定；

（3）本发明提供一种多方协作开发聚合API的方法，将对接开放API平台的工作从聚合API系统开发工作中剥离出去，有利于多个研发团队一起合作开发，加快推进整个聚合API系统功能的扩展。

附图说明

图1为本发明提出的聚合API系统的框架结构图。

图2为本发明提出的适合多方协作开发的聚合API开发方法的三层代码库的依赖关系图。

图3为本发明提出的适合多方协作开发的聚合API开发方法及系统的流程图。

图4为本发明提出的聚合API系统的公共代码库调用对接开放API平台的代码库的流程图。

图5为生成本发明提出的聚合API系统的公共代码库与对接开放API平台的代码库的映射关系的流程图。

图6为第三方开发者使用本发明提出的聚合API系统的流程图。

图7为本发明提出的聚合API系统服务器响应第三方应用的请求的流程图。

图8为多方协作开发的对接开放API平台的代码库的基本流程图。

具体实施方式

下面结合附图和实施例，对本发明的具体实施方式作进一步详细描述。

如图1所示，为本发明提出的聚合API系统的框架结构，以聚合API系统服务器为中心，第三方开放者通过聚合API系统客户端配置开发参数，聚合API系统服务器帮助第三方开发者对接开放API平台，响应第三方应用发起的API请求。

如图2所示，为了使对接开放API平台的工作适合多个开发者协作完成，本发明提出了一种适合多方协作开发的聚合API开发方法。如图1所述的聚合API系统系统的代码，由聚合系统代码、公共代码库、和多个对接开放API平台的代码库组成，公共代码库与对接开放API平台的代码库相互依赖，聚合系统的代码需要依赖公共代码库和对接开放API平台的代码库，由多个开发者分开负责对接开放API平台的代码库的研发。

图3为本发明提出的适合多方协作开发的聚合API开发方法及系统的流程图，包括以下步骤：

步骤S1、创建聚合API公共代码库。它的作用是：定义对接开放API平台的代码库应实现的接口Interface；提供生成公共代码库与对接开放API平台的代码库的映射关系的方法；处理API请求与响应的逻辑；

步骤S2、多方协作开发对接开放API平台的代码库，实现步骤S1所述的对接开放API平台的代码库应实现的接口Interface，一个对接开放API平台的代码库关联一个开放API平台；

步骤S3、利用聚合API公共代码库和对接开放API平台的代码库，设计聚合API系统，包括聚合API系统客户端与聚合API系统服务器，聚合API系统客户端用于第三方开发者配置开发参数，聚合API系统服务器用于响应第三方应用的API请求；

步骤S4、第三方开发者使用聚合API系统客户端，注册开发者帐号，创建开发者应用，配置开发参数，还可以查看API处理日志；

步骤S5、聚合API系统服务器处理响应第三方开发者应用的API请求。

如图4所示，本发明提出的适合多方协作开发的聚合API开发方法的公共代码库处理请求的流程如下：

步骤401、公共代码库中处理API请求的方法是被聚合API系统代码调用的，每一个公共代码库中处理API请求的方法，都是以预先定义好的请求参数列表映射类，作为接收的参数的类型，都是以预先定义好的响应参数列表映射类，作为响应值类型，聚合支付系统的代码将接请求信息，转换为请求参数列表映射类，然后调用公共代码库，然后根据响应参数列表映射类，返回格式化响应值；

步骤402、公共代码库提取请求的参数中代表请求唯一性的字段值，在数据库中查询此次请求相关的数据信息；

步骤403、是否匹配到请求，如果没有，那么进入步骤404，如果有，那么取出数据记录，进入步骤405；

步骤404、如果步骤403没有匹配到请求，那么将请求的数据信息插入到数据库，状态是请求中，通过唯一性字段能再次读取这条记录；

步骤405、如果步骤403匹配到请求，那么提取数据记录中表示状态的字段值，进入步骤406；

步骤406、数据库中存在请求的数据记录的情况下，判断数据记录的状态是不是已经是最后结果（如在支付接口中，取消支付以后，这个交易的状态不会再被修改），如果不是，那么进入步骤407，如果是最后结果，那么直接跳转到步骤412；

步骤407、如果步骤406数据不是最终状态，那么将数据的状态修改成请求中，准备再次请求；

步骤408、从调用本方法的请求参数中，提取对接开放API平台的代码库的关键字段；

步骤409、使用步骤408得到的关键字段的值，通过公共代码库与对接开放API平台的代码库的映射关系，找出处理请求的对接开放API平台的代码库的方法；

步骤410、使用步骤409找到的方法，发起开放API平台请求并解析结果，这个方法在公共代码库定义定义对接开放API平台的代码库应实现的接口Interface的时候，规定了请求参数类型以及返回结果类型；

步骤411、根据步骤410得到的返回结果更新数据库中记录的状态；

步骤412、返回结果，退出公共代码库方法，进入聚合API系统代码处理。

如图5所示，本发明提出的适合多方协作开发的聚合API开发方法，公共代码库中有一个方法，用来生成公共代码库与对接开放API平台的代码库的映射关系，该生成映射关系的方法的工作流程如下：

步骤501、声明用来存储映射关系的变量，它保存的值得结构为：[{接口名Interface1:[{关键字段值1: 具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]},{接口名Interface2:[{关键字段值1: 具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]},...,{接口名Interfacen:[{关键字段值1: 具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]}]，接口名Interface就是公共代码库定义的对接开放API平台的代码库应实现的接口Interface，关键字段值就是实现了接口名Interface的类返回的它所支持的API请求的关键字段，具体实现类就是实现了接口名Interface的类的名称；

步骤502、读取对接开放API平台代码库的存放目录的配置，该配置的目的是缩小查找公共代码库定义的对接开放API平台的代码库应实现的接口Interface的具体实现类的位置；

步骤503、判断是否有读取到步骤502所述的目录配置、如果是，那么进入步骤504、否则进入步骤505；

步骤504、设置步骤503读取到的配置目录为匹配映射关系的目录，进入步骤506；

步骤505、设置项目根目录为匹配映射关系的目录；

步骤506、开始遍历步骤504或者步骤505所设置的匹配映射关系的目录；

步骤507、判断步骤506正在遍历的目录是否存在下一个文件，如果有那么进入步骤508，如果没有那么进入步骤510；

步骤508、如果步骤507发现有下一个文件，那么在这一步解析这个文件，判断这个文件是否为公共代码库定义的对接开放API平台的代码库应实现的接口Interface的具体实现类，如果是那么进入步骤509，否则进入步骤507；

步骤509、继续解析步骤508所述文件、通过该具体类中返回该具体类支持的关键字段的方法，获取该具体类支持的关键字段，然后按照步骤501所述的结构更新存储映射关系的变量，然后再次回到步骤507；

步骤510、当步骤507已经找不到下一个文件时，说明已经遍历了所有文件，此时将步骤501所述的存储映射关系变量转换为json文件保存，公共代码库从此文件匹配处理请求的对接开放API平台的代码库的方法。

如图6所示，第三方开发者使用本发明提出的聚合API系统的流程如下：

步骤601、第三方开发者通过聚合API系统客户端，注册聚合API系统账号；

步骤602、第三方开发者使用步骤601注册的帐号登陆聚合API系统客户端；

步骤603、第三方开发者通过聚合API系统客户端创建一个应用，用于第三方应用与聚合API系统服务器的开发对接，这个应用含有两个关键信息，唯一标识和秘钥；

步骤604、第三方开发者通过聚合API系统客户端为步骤603创建的应用，配置开放API平台相关的参数；

步骤605、第三方开发者使用步骤603创建的应用做好第三方系统与聚合API系统服务器之间的程序对接。

如图7所示，本发明提出的聚合API系统服务器处理第三方应用的API请求的流程如下：

步骤701、聚合API系统服务器接收到第三方应用使用HTTP协议发起的API请求；

步骤702、提取步骤701收到的请求中代表对接应用的唯一标识的请求参数，这个唯一标识是第三方开发者通过图6中说明的聚合API系统客户端建立的 ；

步骤703、使用步骤702所述的唯一标识，从数据库中读取对接应用的配置信息；

步骤704、判断步骤703是否真的读取到配置信息，如果读取到了，那么进入步骤705，否则，说明请求参数是有问题的，进入步骤712；

步骤705、从步骤703得到的配置信息中提取秘钥，用于校验请求参数中签名是否有效；

步骤706、根据步骤705获取的秘钥判断签名是否有效，签名是将请求的参数加上秘钥值按照约定的方式排列组合生成的无法解密的加密字符串，秘钥是受保护的不应该被公开的，仅存在于第三方应用服务器与聚合API系统服务器上的保密信息，如果签名有效那么进入步骤707，如果签名无效那么进入步骤712；

步骤707、从步骤703得到的配置信息中，提取开放API平台的相关的参数配置，根据对接开放API平台的代码库的要求将这些参数设置在程序运行的环境变量中，供对接开放API平台的代码库调用；

步骤708、提取步骤701接收到的请求中代表接口名称的请求参数，接口名称的参数值是一个能按照特定规则解析成应该被调用的公共代码库中处理该请求的文件的文件路径的值；

步骤709、将步骤708提取的接口名称解析成需要调用的公共代码库中处理该请求的文件，调用公共代码库中，公共代码库如图4所述，处理该请求；

步骤710、解析步骤709调用公共代码库后得到处理结果；

步骤711、步骤710解析后的结果。以请求成功的消息响应第三方应用服务器；

步骤712、如果聚合API系统服务器接收到的请求参数不是约定的合法请求参数、或者系统异常等情况，聚合API系统服务器奖以失败的消息响应这个第三方应用的请求。

如图8所示，多方协作开发的对接开放API平台的代码库的基本的流程如下：

步骤801、对接开放API平台的代码库是被聚合API公共代码库调用的；

步骤802、解析参数，聚合API公共代码库在定义对接开放API平台的代码库应实现的接口Interface时，规定了公共代码库调用对接API平台的代码库时传递的参数类型，根据这种规定将参数映射成开放API平台规定的请求参数；

步骤803、处理开放API平台相关逻辑，各个对接开放API平台的开发者自行组织其中的代码逻辑；

步骤804、根据聚合API公共代码库定义的，对接开放API平台的代码库应实现的接口Interface，规定的返回值类型，格式化开放API平台的响应值；

步骤805、将步骤804所述响应值返回聚合API公共代码库。

以上实施方式仅用于说明本发明，而并非对本发明的限制，有关技术领域的普通技术人员，在不脱离本发明的精神和范围的情况下，还可以做出各种变化和变型，因此所有等同的技术方案也属于本发明的范畴，本说明书中未作详细描述的内容属于本领域专业技术人员公知的现有技术，本发明的专利保护范围应由权利要求限定。

Claims (5)

1.一种适合多方协作开发的聚合API开发方法及系统，其特征在于，包括以下步骤：

S1、创建聚合API公共代码库；

S2、多方协作开发对接开放API平台的代码库；

S3、利用聚合API公共代码库和对接开放API平台的代码库，设计聚合API系统，包括聚合API系统客户端和聚合API系统服务器；

S4、第三方开发者通过聚合API系统客户端配置开发参数；

S5、聚合API系统服务器响应第三方应用的API请求。

2.如权利要求1所述的方法，其特征在于，步骤S1的具体作用包括，定义对接开放API平台的代码库应实现的接口Interface，提供生成公共代码库与对接开放API平台的代码库的映射关系的方法，处理响应API请求的逻辑；

所述对接开放API平台的代码库应实现的接口Interface具体为，使用面向对象程序设计(Object Oriented Programming)方法，为每个处理API的方法定义相应的接口Interface，每个所定义的接口Interface都有两个基本的方法，一个方法返回这个接口Interface具体实现类支持哪种API请求的关键字段，没有参数，返回值是关键字段列表；另一个方法是被公共代码库调用的用于向开放API平台发起请求的方法，这个方法的参数类型由公共代码库规定，这个方法的返回值也是由公共代码库规定的固定类型；

所述生成公共代码库与对接开放API平台的代码库的映射关系的方法具体为，遍历对接开放API平台代码库的目录下的所有文件，检查所遍历的文件是否是实现对接开放API平台的代码库应实现的接口Interface的具体实现类，将检查匹配到的结果按以下格式保存为json文件：[{接口名Interface1:[{关键字段值1: 具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]},{接口名Interface2:[{关键字段值1:具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]},...,{接口名Interfacen:[{关键字段值1: 具体实现类1},{关键字段值2: 具体实现类2}, ..., {关键字段值n: 具体实现类n}]}]，接口名Interface就是公共代码库定义的对接开放API平台的代码库应实现的接口Interface，关键字段值就是实现了接口名Interface的类返回的它所支持的API请求的关键字段，具体实现类就是实现了接口名Interface的类的名称；

所述响应API请求的逻辑的方法，具体流程为，公共代码库的方法被聚合API系统代码调用，使用公共代码库与对接开放API平台的代码库的映射关系，调用对接开放API平台的代码库，获得开放API平台的响应结果，格式化响应结果，返回聚合API系统代码的逻辑。

3.如权利要求1所述的方法，其特征在于，步骤S2的具体特征为，对接开放API平台的代码库应实现如权利要求2所述的对接开放API平台的代码库应实现的接口Interface，一个对接开放API平台的代码库关联一个开放API平台，多个对接开放API平台的代码库之间没有相关性，因此本发明所述的开发方法适合多方协作，每个开发者负责一个对接开放API平台的代码库。

4.如权利要求1所述的方法，其特征在于，步骤S3所述聚合API系统客户端或步骤S4，具体为：

S41、第三方开发者使用聚合API系统，首先需要注册开发者帐号，并使用帐号登陆客户端；

S42、创建开发者应用，包括用含有两个关键信息，唯一标识和秘钥，唯一标识别用于聚合API系统服务器收到第三方应用API请求时，从聚合API系统服务器获取第三方开发者在聚合API系统设置的相关配置信息，秘钥用于第三方开发者请求之前生成签名，以及服务器在收到第三方应用请求时验证签名；

S43、为S42所述开发者应用配置开发API平台相关参数，这些参数是对接开放API平台的代码库关联开放API平台，使用的环境变量；

S44、第三方开发者还可以查看聚合API系统服务器处理第三方应用API请求的日志，具体特征为，聚合API系统的服务器收到第三方应用的请求，会将这次请求的参数和响应结果保存在数据库中，聚合API系统客户端会列出所有第三方应用的请求信息。

5.如权利要求1所述的方法，其特征在于，步骤S3所述聚合API系统服务器或步骤S5，具体为：

S51、聚合API系统服务器收到第三方应用使用HTTP协议发起的API请求，提取权利要求4所述，代表对接应用的唯一标识的请求参数；

S52、根据S51所述唯一标识，从数据库中读取对接应用的，如权利要求4所述的配置信息；

S53、从S52所述配置信息中提取秘钥，校验请求参数的签名是否有效；

S54、调用公共代码库中处理该请求的方法，具体特征为，提取接收到的请求中代表接口名称的请求参数，接口名称的参数值是一个能按照特定规则解析成应该被调用的公共代码库中处理该请求的文件的文件路径的值，获得文件路径，然后调用规定的方法；

S55、格式化公共代码库响应的结果，并响应第三方应用的API请求。

Images