CN109165039A - 一种web API的配置及执行方法、系统及介质 - Google Patents

Abstract

本发明公开了一种web API的配置及执行方法、系统及介质。所公开的web API的配置及执行方法，包括：获取web API的名称或唯一标识符、web API所涉及的web字段名、web API的操作类型；获取web API所涉及的数据库和/或数据表和数据字段名；存储名称或唯一标识符、操作类型、web字段名与数据字段名之间的映射关系，从而完成web API的接口配置操作。所公开的技术方案，只需通过对数据库进行配置就可以生成API，不仅提高了软件和服务供应商实现API的效率，还降低了后期对API的维护成本。

Description

一种web API的配置及执行方法、系统及介质

技术领域

本发明涉及计算机网络和数据库领域，尤其涉及一种web API的配置及执行方法、系统及介质。

背景技术

在传统的web应用开发中，对于web API的设计和实现，主要采用以下两种方法：

第一种方法是在代码层面创建API。即软件开发商在开发一套商业软件时，根据软件的使用场合，设计和创建出API，一旦软件开发完成，这些API也就被创建了出来。要是以后有新的业务需求，需要创建新的API，则需要重新编写代码，这种创建API方式不灵活，且需要编写新的代码，创建出的API也不方便管理。

第二种方法是通过一些软件服务提供商的API Gateway平台，在第一种方式创建的API的基础上，对原先老旧的、不适合现有业务情景的API进行拓展，这种方式可以在不编写代码的情况下，为原来的API增加新的请求参数、改变原来API的请求方式(例如，将get请求变为post请求、将post请求变为get请求等)、改变响应体的属性等等，从而生成一些新的API，这种创建API的方式依赖原有的API，只能在原来的API的基础上进行拓展创建，方式较为单一。

涉及数据库操作的每个API通常都包含以下三个操作步骤：1.接收访问请求；2.处理业务逻辑得到处理结果；3.持久化处理结果。

在持久化处理结果的操作中，往往还需要对数据库和持久化代码进行另外地配置。即，在根据新的需求增加新的API设计和实现之后，还需要对应地增加新的配置文件，并对这些配置文件进行维护。尽管软件设计师们在后来提出了ORM的概念，但是数据库和持久化业务代码之间的配置仍然十分繁琐，本质上并没有发生任何改变。

由于现有技术的设计和实现步骤繁琐、效率底下、后期维护成本高、与web API相关的配置操作复杂，因此，需要提出新的技术方案。

发明内容

根据本发明的web API的配置及执行方法，包括：

获取web API的名称或唯一标识符、web API所涉及的web字段名、web API的操作类型；

获取web API所涉及的数据库和/或数据表和数据字段名；

存储名称或唯一标识符、操作类型、web字段名与数据字段名之间的映射关系，从而完成web API的接口配置操作。

根据本发明的web API的配置及执行方法，还包括：

接收web API的执行请求；

基于名称或唯一标识符、操作类型、web字段名、映射关系、执行请求中与web字段名对应的web字段值，自动构造用于访问数据库的SQL语句；

执行SQL语句并获取SQL语句执行结果；

基于数据字段名、映射关系、SQL语句执行结果中与数据字段名对应的数据字段值，自动构造web API的执行结果。

根据本发明的web API的配置及执行方法，在完成web API的接口配置操作的步骤之后，还包括：

结合数据库进行与web API相关的功能性测试。

根据本发明的web API的配置及执行方法，其接口配置操作还包括：

存储用于指示针对不同客户是否启用web API的状态指示标识。

根据本发明的web API的配置及执行方法，其映射关系使用Swagger规范进行描述。

根据本发明的web API的配置及执行系统，包括：

web配置输入模块，用于获取web API的名称或唯一标识符、web API所涉及的web字段名、web API的操作类型；

数据库配置输入模块，用于获取web API所涉及的数据库和/或数据表和数据字段名；

配置信息存储模块，用于存储名称或唯一标识符、操作类型、web字段名与数据字段名之间的映射关系，从而完成web API的接口配置操作。

根据本发明的web API的配置及执行系统，还包括：

web接口模块，用于接收web API的执行请求，以及，用于发送web API的执行结果；

转换模块，用于基于名称或唯一标识符、操作类型、web字段名、映射关系、执行请求中与web字段名对应的web字段值，自动构造用于访问数据库的SQL语句，以及，用于基于数据字段名、映射关系、SQL语句执行结果中与数据字段名对应的数据字段值，自动构造webAPI的执行结果；

SQL语句执行模块，用于执行SQL语句并获取SQL语句执行结果。

根据本发明的web API的配置及执行系统，还包括：

测试模块，用于在完成web API的接口配置操作之后，结合数据库进行与web API相关的功能性测试。

根据本发明的web API的配置及执行系统，其配置信息存储模块还用于：

存储用于指示针对不同客户是否启用web API的状态指示标识。

根据本发明的计算机可读存储介质，存储介质上存储有计算机程序，程序被处理器执行时实现上文所述的方法的步骤。

根据本发明的上述技术方案，只需通过对数据库进行配置就可以生成API，不仅提高了软件和服务供应商实现API的效率，还降低了后期对API的维护成本。

附图说明

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

图1示例性地示出了根据本发明的web API的配置及执行方法的示意流程图。

图2示例性地示出了根据本发明的web API的配置及执行系统的示意框图。

图3示例性地示出了根据本发明的web API的配置及执行系统的一个示例的示意图。

图4示例性地示出了图3所示的示例系统中的Crystal模块及其相关操作步骤的示意图。

具体实施方式

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

图1示例性地示出了根据本发明的web API的配置及执行方法的示意流程图。

如图1的实线框所示，根据本发明的web API的配置及执行方法，包括：

步骤S102：获取web API的名称或唯一标识符、web API所涉及的web字段名、webAPI的操作类型；

步骤S104：获取web API所涉及的数据库和/或数据表和数据字段名；

步骤S106：存储名称或唯一标识符、操作类型、web字段名与数据字段名之间的映射关系，从而完成web API的接口配置操作。

可选地，如图1的虚线框所示，根据本发明的web API的配置及执行方法，还包括：

步骤S108：接收web API的执行请求；

步骤S110：基于名称或唯一标识符、操作类型、web字段名、映射关系、执行请求中与web字段名对应的web字段值，自动构造用于访问数据库的SQL语句；

步骤S112：执行SQL语句并获取SQL语句执行结果；

步骤S114：基于数据字段名、映射关系、SQL语句执行结果中与数据字段名对应的数据字段值，自动构造web API的执行结果。

可选地，如图1的虚线框所示，根据本发明的web API的配置及执行方法，在完成web API的接口配置操作的步骤之后，还包括：

步骤S116：结合数据库进行与web API相关的功能性测试。

测试者可以进入用于测试的交互操作界面，在其中选择需要测试的具体web API的名称或标识，根据系统提示进行测试操作。例如，如果要对执行写入数据库操作(例如，对应http协议支持的post类型的操作)的web API进行功能性测试，则需要填写需要增加的记录中的各个名称的web字段所对应的web字段值(例如，通过交互操作界面中的用户名、用户ID、出生日期、性别等文本输入框输入的文本或数值、或通过对应的列表框选择的文本或数值)；然后点击“执行”或“确定”按钮提交测试请求；根据交互界面中返回的结果(例如，http响应的内容、和/或新增加的记录的具体信息)来判断web API的执行是否成功(例如，如果http响应代码为200、数据库中新增加的记录与输入记录相同，则认为测试成功；否则，则认为测试成功)。

可选地，也可以通过自动化测试程序来自动执行上述功能性测试。

例如，可以在设计API的同时(即，在步骤S106中)，把包含测试数据和正确测试结果的测试用例(模板)配置好。采用这种方法，在每次提交相关的测试用例(模板)之后，系统会自动将测试数据发送到后台，并自动比对实际测试结果与正确测试结果是否一致，从而自动输出测试是否成功的结论。

可选地，如图1的虚线框所示，根据本发明的配置及执行方法，接口配置操作还包括：

步骤S118：存储用于指示针对不同客户是否启用web API的状态指示标识。

可选地，根据本发明的配置及执行方法，其映射关系使用Swagger规范进行描述。

例如，Swagger规范可以用于描述web API的操作类型。类型为读的API对应http的get、head请求，类型为写的API对应http的put、post、delete等请求。

例如，可以采用以下方式定义对应http post类型的web API所涉及的一个web字段A：

“post”:{

…

“parameters”:

{

“in”：“path”,

“name”：“A”,

“required”：“true”,

“type”：“integer”

…}

…

}

例如，可以采用以下方式定义上述web字段A和一个数据库字段B之间的一一映射关系：

{…

“columnName”：“B”,

“value”：“A”

…}

即，数据库字段和API参数(即，web字段)之间的对应关系是：一个数据库字段与一个API参数及其参数值对应(不存在一对多关系，数据库字段和API参数均为一一对应)。

可以根据需要类似地添加各种类型的web API、及其涉及的web字段和数据库字段。

图2示例性地示出了根据本发明的web API的配置及执行系统200的示意框图。

如图2的实线框所示，web API的配置及执行系统200包括：

web配置输入模块201，用于获取web API的名称或唯一标识符、web API所涉及的web字段名、web API的操作类型；

数据库配置输入模块203，用于获取web API所涉及的数据库和/或数据表和数据字段名；

配置信息存储模块205，用于存储名称或唯一标识符、操作类型、web字段名与数据字段名之间的映射关系，从而完成web API的接口配置操作。

例如，这里的数据库可以是图3中所示的“客户数据库系统”或“D2A业务数据库”。

例如，配置信息存储模块205可以将上述配置信息存储到D2A业务数据库中。

可选地，如图2的虚线框所示，web API的配置及执行系统200还包括：

web接口模块207，用于接收web API的执行请求，以及，用于发送web API的执行结果；

转换模块209，用于基于名称或唯一标识符、操作类型、web字段名、映射关系、执行请求中与web字段名对应的web字段值，自动构造用于访问数据库的SQL语句，以及，用于基于数据字段名、映射关系、SQL语句执行结果中与数据字段名对应的数据字段值，自动构造web API的执行结果；

SQL语句执行模块211，用于执行SQL语句并获取SQL语句执行结果。

可选地，如图2的虚线框所示，web API的配置及执行系统200还包括：

测试模块213，用于在完成web API的接口配置操作之后，结合数据库进行与webAPI相关的功能性测试。

可选地，上述配置信息存储模块205还用于：

存储用于指示针对不同客户是否启用web API的状态指示标识。

结合根据本发明的上述方法和系统，还提出了一种计算机可读存储介质，存储介质上存储有计算机程序，程序被处理器执行时实现图1所示的方法的步骤。

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

图3示例性地示出了根据本发明的web API的配置及执行系统的一个示例的示意图。

由图3中的虚线框所示出的该示例系统，在本文中也将其称作D2A(Database toAPI)系统，是以数据库中的数据表作为操作对象、以Swagger规范(现在也被叫做OpenAPI规范)作为描述API基本功能的模板来创建API的。

Swagger规范本身只是一个开源的，用于描述API的一套协议，描述出来的API是无法根据数据库数据来创建API的。然而，Swagger可以让开发者根据实际的应用场景对Swagger规范进行拓展使之能够满足开发者的业务需求。本发明的上述技术方案不限于Swagger规范，也可以是诸如XML、JSON的其他规范或用户自定义规范。

如图3中的虚线框所示，该示例系统包括以下模块或系统：D2A业务数据库、CoreAPI模块和Crystal模块。

D2A业务数据库用于存储D2A系统(其为web系统)运行期间产生的大量业务数据，业务数据包括上述名称或唯一标识符、操作类型、web字段名与数据字段名之间的映射关系等API配置信息。

CoreAPI模块是用于创建、测试和管理API的业务模块。创建API期间会将API的相关信息和拓展的Swagger信息(即，图3中所示的拓展的Swagger文档)存入D2A业务数据库(相当于图2中所示的“web配置输入模块201”、“数据库配置输入模块203”、“配置信息存储模块205”、“测试模块213”)，客户在调用API期间，则会处理Crystal的请求，把和被调用API有关的拓展Swagger信息返回给Crystal(相当于图2中所示的“配置信息存储模块205”)。

Crystal模块是D2A系统中的后端服务模块，也是该示例系统的一个核心模块，用于处理客户(API调用者)调用的API请求(相当于图1中所示的步骤S108和图2中所示的“web接口模块207”)，把处理的API结果返回给调用者(相当于图1中所示的步骤S114和图2中所示的“web接口模块219”)。

图3中还示出了一个客户数据库系统。该客户数据库系统用于存储第三方业务系统的外部数据，相当于上文结合图1所述的技术方案中的数据库，不属于该示例系统。即，在该示例中，将D2A系统所创建的API限定为用于该客户数据库系统中的数据库，而非用于D2A业务数据库自身，如上文所述，D2A业务数据库用于存储API配置信息。

对应于结合图1所述的“配置”过程：

例如，如图3所示，基于数据库数据来配置(即，定义或声明)一个或者说一组API，分为以下几个步骤：

S1：使用者创建API，授权相关的数据库系统操作权限，使得本系统可以接入使用者的数据库系统。

S2(对应于图1中的步骤S102和S104)：使用CoreAPI接入客户数据库系统以后，就可以读取到相关的数据库数据，使用者以这些数据库数据(主要是数据表里面的数据字段)为基本信息，对所要创建的API进行配置。对一个API进行创建和配置主要包括：

(1)选择与API对应的数据表(即这个API是对哪张数据表进行CURD操作)。

(2)选择API的类型，是读类型还是写类型(见“API类型”)。

(3)选择数据库字段，取决于选择的API类型，这些被选中的数据库字段将会有不同的用途。

(4)定义API参数(即，上述web字段名)，并将所定义的参数与上一步选中的数据库字段进行参数到字段的映射。

其中，API是读类型是指，调用API主要能从数据库中获取到数据、API是写类型是指，调用API主要往数据库中写入数据，包括对数据库数据的增删改等。类型为读的API对应restful中的get请求，类型为写的API对应restful中的post和delete请求。其中post请求对应数据库的增、改操作，delete请求对应数据库的删操作。如上文所述，可选地，web API的类型也可以采用Swagger规范进行描述。

S3(对应于图1中的步骤S106)：完成API的配置，将API的相关配置保存到本系统中的业务数据库中，相关配置信息包括API基本信息(例如，上述名称或唯一标识符、操作类型、web字段名与数据字段名)和Swagger拓展信息(例如，上述web字段名与数据字段名之间的映射关系)。

S4(对应于图1中的步骤S116)：可选步骤，对所创建的数据库进行功能性测试，检查是否符合预期的功能。

S5(对应于图1中的步骤S118)：API管理功能，对API进行管理，可对单个API设置它针对不同客户的启用状态，也可以为API所对应的数据库信息进行设置，若数据库信息被设置为关闭，那么与该数据库对应的全部API将不可用(这些规定都是来自于本发明技术方案中那个拓展的Swagger规则)。

对应于结合图1所述的“执行”过程：

图4示例性地示出了图3所示的示例系统中的Crystal模块及其相关操作步骤的示意图。

如图4所示，对于已经创建好的API，调用者在调用API的时候，会将http请求转发到Crystal服务执行。具体的执行过程包括：

S6.1(对应于图1中的步骤S108)：客户调用创建好的API，http请求会被发送到Crystal服务的Http Server模块。

S6.2(对应于图1中的步骤S110中的获取“映射关系”)：Http Server接收到调用者(客户)调用的API请求后，会根据请求信息去CoreAPI调用Swagger文档。

S6.3：成功获取到Swagger文档后，Crystal的Swagger Validator模块会对这个Swagger文档进行解析验证，判断API调用者发出的http请求中是否包含Swagger文档中描述的信息，并根据验证结果决定是否继续执行后续程序。

S6.4(对应于图1中的步骤S110)：当Swagger文档验证通过以后，Sql builder模块便会根据Swagger文档中的拓展信息连接客户数据库系统，并构造SQL语句。

S6.5(对应于图1中的步骤S112)：构造好SQL语句以后，Crystal的Sql Executor模块便会执行SQL语句。

S6.6(对应于图1中的步骤S114)：把执行SQL语句得到的结果返回给API调用者。

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

1)扩展了创建API的方式，给用户提供了更多的选择。

2)创建API的过程简单灵活、对API的管理方便。

3)不依赖于使用者的任何业务系统，创建的API也和使用者的业务系统完全解耦。

4)兼容多种主流的关系型数据库系统(包括mysql、oracle、sqlserver、postgresql、ibmdb2等)，程序架构科学合理，对新数据库的拓展方便。

5)功能完善，实用性强，除了提供创建API的模块以外，还可以提供对所创建的API进行功能性测试、以及查看API使用帮助的模块，使得整个技术方案更具有实用性。

根据本发明的上述技术方案提出了一种基于对数据库的配置来实现API的设计和实现的新思路。即，基于数据库的数据来配置API(这是API的外形)，然后基于业务场景制定的(例如，符合Swagger规范的)扩展信息来执行API(这是API的实际功能)。

根据本发明的上述技术方案解决了如何通过对数据库的配置来生成API的问题，只需通过对数据库进行配置就可以生成API，改变了常规API的实现方式，不仅提高了软件和服务供应商实现API的效率，还降低了后期对API的维护成本。

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

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

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

Claims (10)

1.一种web API的配置及执行方法，其特征在于，包括：

获取所述web API的名称或唯一标识符、所述web API所涉及的web字段名、所述webAPI的操作类型；

获取所述web API所涉及的数据库和/或数据表和数据字段名；

存储所述名称或唯一标识符、所述操作类型、所述web字段名与所述数据字段名之间的映射关系，从而完成所述web API的接口配置操作。

2.如权利要求1所述的web API的配置及执行方法，其特征在于，还包括：

接收所述web API的执行请求；

基于所述名称或唯一标识符、所述操作类型、所述web字段名、所述映射关系、所述执行请求中与所述web字段名对应的web字段值，自动构造用于访问所述数据库的SQL语句；

执行所述SQL语句并获取SQL语句执行结果；

基于所述数据字段名、所述映射关系、所述SQL语句执行结果中与所述数据字段名对应的数据字段值，自动构造所述web API的执行结果。

3.如权利要求2所述的web API的配置及执行方法，其特征在于，在完成所述web API的接口配置操作的步骤之后，还包括：

结合所述数据库进行与所述web API相关的功能性测试。

4.如权利要求2所述的web API的配置及执行方法，其特征在于，所述接口配置操作还包括：

存储用于指示针对不同客户是否启用所述web API的状态指示标识。

5.如权利要求2所述的web API的配置及执行方法，其特征在于，所述映射关系使用Swagger规范进行描述。

6.一种web API的配置及执行系统，其特征在于，包括：

web配置输入模块，用于获取所述web API的名称或唯一标识符、所述web API所涉及的web字段名、所述web API的操作类型；

数据库配置输入模块，用于获取所述web API所涉及的数据库和/或数据表和数据字段名；

配置信息存储模块，用于存储所述名称或唯一标识符、所述操作类型、所述web字段名与所述数据字段名之间的映射关系，从而完成所述web API的接口配置操作。

7.如权利要求6所述的web API的配置及执行系统，其特征在于，还包括：

web接口模块，用于接收所述web API的执行请求，以及，用于发送所述web API的执行结果；

转换模块，用于基于所述名称或唯一标识符、所述操作类型、所述web字段名、所述映射关系、所述执行请求中与所述web字段名对应的web字段值，自动构造用于访问所述数据库的SQL语句，以及，用于基于所述数据字段名、所述映射关系、SQL语句执行结果中与所述数据字段名对应的数据字段值，自动构造所述web API的执行结果；

SQL语句执行模块，用于执行所述SQL语句并获取所述SQL语句执行结果。

8.如权利要求6或7所述的web API的配置及执行系统，其特征在于，还包括：

测试模块，用于在完成所述web API的接口配置操作之后，结合所述数据库进行与所述web API相关的功能性测试。

9.如权利要求6或7所述的web API的配置及执行系统，其特征在于，所述配置信息存储模块还用于：

存储用于指示针对不同客户是否启用所述web API的状态指示标识。

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