CN113448985A - 一种api接口生成方法、调用方法、装置及电子设备 - Google Patents

Abstract

本申请提供一种API接口生成方法、调用方法、装置及电子设备，该API接口调用方法包括：获取当前数据请求对应的SQL查询语句；根据SQL查询语句的语义信息，确定目标数据的数据类型；根据目标数据的数据类型，生成SQL查询语句对应的API接口。上述方案提供的方法，通过分析SQL查询语句的语义信息，来确定目标数据的数据类型，进而自动生成对应的API接口，提高了API接口的开发效率，降低了API接口开发门槛。

Description

一种API接口生成方法、调用方法、装置及电子设备

技术领域

本申请涉及数据库技术领域，尤其涉及一种API接口生成方法、调用方法、装置及电子设备。

背景技术

随着大数据时代的到来，各个行业已经逐步实现信息化办公。各单位往往应自身业务发展需要，使用业务系统从企业数据库提取目标数据。其中，由于不同的表单由于表结构、业务逻辑等属性的不同，所以需要为业务系统开发不同的API接口。

在现有技术中，通常先将数据请求发送到企业数据库，企业数据库按照数据请求提取目标数据，在将目标数据返回到业务系统之前，研发人员根据目标数据的数据类型，通过编写大量的SQL语句为业务系统开发可接收目标数据的API接口。

但是，由于目前的API接口开发过程较为繁琐，导致API接口开发效率较低。

发明内容

本申请提供一种API接口生成方法、调用方法、装置及电子设备，以解决现有技术API接口开发效率低等缺陷。

本申请第一个方面提供一种API接口生成方法，包括：

获取当前数据请求对应的SQL查询语句；

根据所述SQL查询语句的语义信息，确定目标数据的数据类型；

根据所述目标数据的数据类型，生成所述SQL查询语句对应的API接口。

可选的，所述根据所述SQL查询语句的语义信息，确定目标数据的数据类型，包括：

构建所述SQL查询语句对应的语法树；

提取所述语法树各节点的SQL语句字段；

根据所述SQL语句字段的字段类型，确定所述目标数据的数据类型。

可选的，所述语法树包括SQL输入节点和SQL输出节点，所述根据所述SQL语句字段的字段类型，确定所述目标数据的数据类型，包括：

根据各节点的SQL语句字段，从所述语法树中筛选SQL输出节点；

根据所述SQL输出节点的SQL语句字段的字段类型，确定所述目标数据的数据类型。

可选的，还包括：

将所述API接口的接口信息添加到API接口文档；其中，所述接口信息至少包括接口定位符、请求方式和入参数据类型。

本申请第二个方面提供一种API接口调用方法，包括：

获取当前数据请求和API接口文档；

根据所述当前数据请求，确定目标API接口；

从所述API接口文档中提取目标API接口的接口信息；

根据所述当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句。

可选的，所述根据所述当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句，包括：

根据当前数据请求和目标API接口的接口信息，确定SQL查询语句的入参数据；

根据所述目标API接口对应的SQL查询语句模板和所述入参数据，生成SQL查询语句。

本申请第三个方面提供一种API接口生成装置，包括：

第一获取模块，用于获取当前数据请求对应的SQL查询语句；

第一确定模块，用于根据所述SQL查询语句的语义信息，确定目标数据的数据类型；

生成模块，用于根据所述目标数据的数据类型，生成所述SQL查询语句对应的API接口。

本申请第四个方面提供一种API接口调用装置，包括：

第二获取模块，用于获取当前数据请求和API接口文档；

第二确定模块，用于根据所述当前数据请求，确定目标API接口；

调用模块，用于从所述API接口文档中提取目标API接口的接口信息；

查询模块，用于根据所述当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句。

本申请第五个方面提供一种电子设备，包括：至少一个处理器和存储器；

所述存储器存储计算机执行指令；

所述至少一个处理器执行所述存储器存储的计算机执行指令，使得所述至少一个处理器执行如上第一个方面以及第一个方面各种可能的设计所述的API接口生成方法或如上第二个方面以及第二个方面各种可能的设计所述的API接口调用方法。

本申请第六个方面提供一种计算机可读存储介质，所述计算机可读存储介质中存储有计算机执行指令，当处理器执行所述计算机执行指令时，实现如上第一个方面以及第一个方面各种可能的设计所述的API接口生成方法或如上第二个方面以及第二个方面各种可能的设计所述的API接口调用方法。

本申请技术方案，具有如下优点：

本申请提供的API接口生成方法、调用方法、装置及电子设备，通过获取当前数据请求对应的SQL查询语句；根据SQL查询语句的语义信息，确定目标数据的数据类型；根据目标数据的数据类型，生成SQL查询语句对应的API接口。上述方案提供的方法，通过分析SQL查询语句的语义信息，来确定目标数据的数据类型，进而自动生成对应的API接口，提高了API接口的开发效率，降低了API接口开发门槛。

附图说明

为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作一简单地介绍，显而易见地，下面描述中的附图是本申请的一些实施例，对于本领域普通技术人员来讲，还可以根据这些附图获得其他的附图。

图1为本申请实施例基于的数据服务系统的结构示意图；

图2为本申请实施例提供的API接口生成方法的流程示意图；

图3为本申请实施例提供的API接口调用方法的流程示意图；

图4为本申请实施例提供的示例性的数据服务系统的控制流程示意图；

图5为本申请实施例提供的示例性的数据服务系统的结构示意图；

图6为本申请实施例提供的API接口生成装置的结构示意图；

图7为本申请实施例提供的API接口调用装置的结构示意图；

图8为本申请实施例提供的电子设备的结构示意图。

通过上述附图，已示出本申请明确的实施例，后文中将有更详细的描述。这些附图和文字描述并不是为了通过任何方式限制本公开构思的范围，而是通过参考特定实施例为本领域技术人员说明本申请的概念。

具体实施方式

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

此外，术语“第一”、“第二”等仅用于描述目的，而不能理解为指示或暗示相对重要性或者隐含指明所指示的技术特征的数量。在以下各实施例的描述中，“多个”的含义是两个以上，除非另有明确具体的限定。

在现有技术中，通常先将数据请求发送到企业数据库，企业数据库按照数据请求提取目标数据，在将目标数据返回到业务系统之前，研发人员根据目标数据的数据类型，通过编写大量的SQL语句为业务系统开发可接收目标数据的API接口。但是，由于目前的API接口开发过程较为繁琐，降低了业务系统与数据库之间的通信效率。

针对上述问题，本申请实施例提供的API接口生成方法、调用方法、装置及电子设备，通过获取当前数据请求对应的SQL查询语句；根据SQL查询语句的语义信息，确定目标数据的数据类型；根据目标数据的数据类型，生成SQL查询语句对应的API接口。上述方案提供的方法，通过分析SQL查询语句的语义信息，来确定目标数据的数据类型，进而自动生成对应的API接口，提高了API接口的开发效率，降低了API接口开发门槛。

下面这几个具体的实施例可以相互结合，对于相同或相似的概念或过程可能在某些实施例中不再赘述。下面将结合附图，对本发明实施例进行描述。

首先，对本申请所基于的数据服务系统的结构进行说明：

本申请实施例提供的API接口生成方法、调用方法、装置及电子设备，适用于为业务系统提供API接口。如图1所示，为本申请实施例基于的数据服务系统的结构示意图，主要包括业务系统、数据库、API接口生成装置和API接口调用装置。具体地，由API接口生成装置为业务系统生成用于接收数据库数据的API接口，并且当业务系统后续有相同的API接口生成需求时，API接口调用装置可以直接为其调用之前已生成的API接口。

本申请实施例提供了一种API接口生成方法，用于为业务系统生成API接口。本申请实施例的执行主体为电子设备，比如服务器、台式电脑、笔记本电脑、平板电脑及其他可用于生成API接口的电子设备。

如图2所示，为本申请实施例提供的API接口生成方法的流程示意图，该方法包括：

步骤201，获取当前数据请求对应的SQL查询语句。

需要说明的是，上述SQL查询语句具体是当前数据请求的一种输出形式。

步骤202，根据SQL查询语句的语义信息，确定目标数据的数据类型。

具体地，可以首先对SQL查询语句进行字段划分，然后根据各字段的内容，分析SQL查询语句的语义信息，从而确定当前对数据库输出内容的要求，这样也就确定了目标数据的数据类型。

步骤203，根据目标数据的数据类型，生成SQL查询语句对应的API接口。

需要说明的是，目标数据的数据类型具体是指目标数据的输出格式，其中，数据类型主要可以分为字符串、浮点数和表单等。

具体地，由于不同数据类型的目标数据所需要的API端口也不相同，所以为了让业务系统可以正常接收目标数据，可以利用预设的API接口生成模型，根据目标数据的数据类型，为业务系统生成对应的API接口。

需要进一步说明的是，由于不同类型的API接口的生成方式也不相同，为了提高API接口生成模型的普适性，可以在模型中封装多套API接口生成程序。当API接口生成模型接收到API接口生成任务时，根据目标数据的数据类型，触发对应的API接口生成程序，进而完成后续的API接口生成工作。

在上述实施例的基础上，由于SQL查询语句的语义信息分析结果的准确性将直接影响目标数据的数据类型判断结果，因此，为了保障目标数据的数据类型判断结果的可靠性，作为一种可实施的方式，在一实施例中，根据SQL查询语句的语义信息，确定目标数据的数据类型，包括：

步骤2021，构建SQL查询语句对应的语法树；

步骤2022，提取语法树各节点的SQL语句字段；

步骤2023，根据SQL语句字段的字段类型，确定目标数据的数据类型。

具体地，可以利用JSqlParser组件解析SQL查询语句，并将其转换为语法树的形式，然后通过递归语法树，提取语法树每个节点的字段(SQL语句字段)。其中，SQL语句字段类型包括查询字段、条件字段、分组字段、排序字段和分页字段等。

其中，语法树包括SQL输入节点和SQL输出节点。SQL输出节点对应用户的输入数据，主要指目标数据的存储路径等，SQL输出节点对应数据库将依据SQL查询数据输出的内容。

具体地，在一实施例中，可以根据各节点的SQL语句字段，从语法树中筛选SQL输出节点；根据SQL输出节点的SQL语句字段的字段类型，确定目标数据的数据类型。

示例性的，若SQL输出节点的SQL语句字段是列类型的字段，则会去查询该列所属的表信息，即对应的目标数据的数据类型为表单。若SQL输出节点的SQL语句字段是求和、求差、求商或求积的字段，则会可以确定其对应的目标数据的数据类型为浮点数类型。

具体地，在一实施例中，为了提高API接口的管理效果，避免重复生成同类API接口，在生成当前SQL查询语句对应的API接口之后，可以将API接口的接口信息添加到API接口文档。

其中，接口信息至少包括接口定位符、请求方式和入参数据类型。其中，接口定位符具体可以指接口URL

需要说明的是，目前高效复用代码已成为软件开发者们的共识。通过API接口文档，开发者们可以清楚、快速地了解到API接口的功能、接口URL、请求方式、入参数据类型、测试用例、使用条件以及使用限制等。例如，接口URL：d.kt.ziroom.com/dataapi/query；请求方式：POST；入参数据类型：application/json。

具体地，在一实施例中，在生成API接口之后，为了验证API接口的可用性，可以对其进行测试，以验证不同条件的组合是否符合业务需求。

本申请实施例提供的API接口生成方法，通过获取当前数据请求对应的SQL查询语句；根据SQL查询语句的语义信息，确定目标数据的数据类型；根据目标数据的数据类型，生成SQL查询语句对应的API接口。上述方案提供的方法，通过分析SQL查询语句的语义信息，来确定目标数据的数据类型，进而自动生成对应的API接口，提高了API接口的开发效率，降低了API接口开发门槛。并且，通过生成对应的API接口文档，实现了高效服用代码，为进一步提高API接口的开发效率奠定了基础，同时降低了接口开发门槛。

本申请实施例提供了一种API接口调用方法，用于为业务系统调用API接口。本申请实施例的执行主体为电子设备，比如服务器、台式电脑、笔记本电脑、平板电脑及其他可用于调用API接口的电子设备。

如图3所示，为本申请实施例提供的API接口调用方法的流程示意图，该方法包括：

步骤301，获取当前数据请求和API接口文档；

步骤302，根据当前数据请求，确定目标API接口；

步骤303，从API接口文档中提取目标API接口的接口信息；

步骤304，根据当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句。

具体地，业务系统可以根据API接口文档，选定可以满足当前数据请求的目标API接口，然后根据目标API接口的接口信息和当前的查询场景(当前数据请求)，生成对应的SQL查询语句。不仅实现了API接口复用，还可以自动生成SQL查询语句，进一步减轻了研发人员的工作负荷。

具体地，在一实施例中，可以根据当前数据请求和目标API接口的接口信息，确定SQL查询语句的入参数据；根据目标API接口对应的SQL查询语句模板和入参数据，生成SQL查询语句。

需要说明的是，SQL查询语句模板是根据API接口生成时分析的SQL查询语句构建。

示例性的，当定义API的SQL查询语句模板为：

select name,code from test.t_user t where t.name＝:name:and t.code＝:code:and t.is_valid＝:isValid:

入参：name＝张三，可以生成的SQL查询语句:

select name,code from test.t_user t where t.name＝'张三'and 1＝1 and1＝1

入参：name＝张三，code＝001，可以生成SQL查询语句：

select name,code from test.t_user t where t.name＝'张三'and code＝'001'and 1＝1

其中，code是API调用时输入的一个条件入参。

具体地，传入的入参数据会被绑定在已定义的SQL查询语句模板上，未传入的会被解析为恒等式1＝1(效果等同于删除掉)以此根据不同入参条件，动态生成不同SQL查询语句，进行查询。

其中，“张三”具体指业务系统的用户名，“001”具体指条件参数。对于上述实施例提出的API接口测试，具体可以验证“001”API接口是否对应用户名“张三”，若对应，则测试通过。

示例性的，如图4所示，为本申请实施例提供的示例性的数据服务系统的控制流程示意图。具体地，在生成API接口后，将对已生成的API接口进行发布，当业务系统后续需要利用API接口时，向数据服务系统剔除API申请，申请通过后，将得到API接口的使用权限。另外，在数据服务系统运行的过程中，将定期对系统进行日常监控和告警监控，其中，日常监控包含：心跳检测、jvm内存使用、GC时间、GC频率等；报警监控包含：Http4XX状态的请求在1分钟内超过10次、Http5XX状态请求在1分钟内超过10次和Full GC每分钟超过2次等。其中，对系统进行监控主要是为了监控系统的健康度，以保障数据服务系统可以正常提供数据服务。

在实际应用中，数据服务系统通常包括多个数据库(数据源)，因此在从采集目标数据之前，需要首先确定目标数据源。其中，本申请实施例可以适应的数据源包括TiDB，ClickHouse和ElasticSearch等类型的数据库。

为了便于本领域技术人员更好地了解本申请实施例提供的技术方案，如图5所示，为本申请实施例提供的示例性的数据服务系统的结构示意图。其中，数据服务系统中各模块的具体工作原理可以参考上述实施例，在此不再赘述。

本申请实施例提供的API接口调用方法，通过获取当前数据请求和API接口文档；根据当前数据请求，确定目标API接口；从API接口文档中提取目标API接口的接口信息；根据当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句。上述方案提供的方法，实现了API接口复用，并且可以自动生成SQL查询语句，提高了业务系统与数据库之间的通信效率。

本申请实施例提供了一种API接口生成装置，用于执行上述实施例提供的API接口生成方法。

如图6所示，为本申请实施例提供的API接口生成装置的结构示意图。该API接口生成装置60包括：第一获取模块601、第一确定模块602和生成模块603。

其中，第一获取模块，用于获取当前数据请求对应的SQL查询语句；第一确定模块，用于根据SQL查询语句的语义信息，确定目标数据的数据类型；生成模块，用于根据目标数据的数据类型，生成SQL查询语句对应的API接口。

关于本实施例中的API接口生成装置，其中各个模块执行操作的具体方式已经在有关该方法的实施例中进行了详细描述，此处将不做详细阐述说明。

本申请实施例提供的API接口生成装置，用于执行上述实施例提供的API接口生成方法，其实现方式与原理相同，不再赘述。

本申请实施例提供了一种API接口调用装置，用于执行上述实施例提供的API接口调用方法。

如图7所示，为本申请实施例提供的API接口调用装置的结构示意图。该API接口调用装置70包括：第二获取模块701、第二确定模块702、调用模块703和查询模块704.

其中，第二获取模块，用于获取当前数据请求和API接口文档；第二确定模块，用于根据当前数据请求，确定目标API接口；调用模块，用于从API接口文档中提取目标API接口的接口信息；查询模块，用于根据当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句。

关于本实施例中的API接口调用装置，其中各个模块执行操作的具体方式已经在有关该方法的实施例中进行了详细描述，此处将不做详细阐述说明。

本申请实施例提供的API接口调用装置，用于执行上述实施例提供的API接口生成方法，其实现方式与原理相同，不再赘述。

本申请实施例提供了一种电子设备，用于执行上述实施例提供的API接口生成方法或API接口调用方法。

如图8所示，为本申请实施例提供的电子设备的结构示意图。该电子设备80包括：至少一个处理器81和存储器82；

所述存储器存储计算机执行指令；所述至少一个处理器执行所述存储器存储的计算机执行指令，使得所述至少一个处理器执行如上实施例提供的API接口生成方法或API接口调用方法。

本申请实施例提供的一种电子设备，用于执行上述实施例提供的API接口生成方法或API接口调用方法，其实现方式与原理相同，不再赘述。

本申请实施例提供了一种计算机可读存储介质，所述计算机可读存储介质中存储有计算机执行指令，当处理器执行所述计算机执行指令时，实现如上任一实施例提供的API接口生成方法或API接口调用方法。

本申请实施例的包含计算机可执行指令的存储介质，可用于存储前述实施例中提供的API接口生成方法或API接口调用方法的计算机执行指令，其实现方式与原理相同，不再赘述。

在本申请所提供的几个实施例中，应该理解到，所揭露的装置和方法，可以通过其它的方式实现。例如，以上所描述的装置实施例仅仅是示意性的，例如，所述单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个系统，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些接口，装置或单元的间接耦合或通信连接，可以是电性，机械或其它的形式。

所述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。

另外，在本申请各个实施例中的各功能单元可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。上述集成的单元既可以采用硬件的形式实现，也可以采用硬件加软件功能单元的形式实现。

上述以软件功能单元的形式实现的集成的单元，可以存储在一个计算机可读取存储介质中。上述软件功能单元存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)或处理器(processor)执行本申请各个实施例所述方法的部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(Read-Only Memory，ROM)、随机存取存储器(Random Access Memory，RAM)、磁碟或者光盘等各种可以存储程序代码的介质。

本领域技术人员可以清楚地了解到，为描述的方便和简洁，仅以上述各功能模块的划分进行举例说明，实际应用中，可以根据需要而将上述功能分配由不同的功能模块完成，即将装置的内部结构划分成不同的功能模块，以完成以上描述的全部或者部分功能。上述描述的装置的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。

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

Claims (10)

1.一种API接口生成方法，其特征在于，包括：

获取当前数据请求对应的SQL查询语句；

根据所述SQL查询语句的语义信息，确定目标数据的数据类型；

根据所述目标数据的数据类型，生成所述SQL查询语句对应的API接口。

2.根据权利要求1所述的方法，其特征在于，所述根据所述SQL查询语句的语义信息，确定目标数据的数据类型，包括：

构建所述SQL查询语句对应的语法树；

提取所述语法树各节点的SQL语句字段；

根据所述SQL语句字段的字段类型，确定所述目标数据的数据类型。

3.根据权利要求2所述的方法，其特征在于，所述语法树包括SQL输入节点和SQL输出节点，所述根据所述SQL语句字段的字段类型，确定所述目标数据的数据类型，包括：

根据各节点的SQL语句字段，从所述语法树中筛选SQL输出节点；

根据所述SQL输出节点的SQL语句字段的字段类型，确定所述目标数据的数据类型。

4.根据权利要求1所述的方法，其特征在于，还包括：

将所述API接口的接口信息添加到API接口文档；其中，所述接口信息至少包括接口定位符、请求方式和入参数据类型。

5.一种API接口调用方法，其特征在于，包括：

获取当前数据请求和API接口文档；

根据所述当前数据请求，确定目标API接口；

从所述API接口文档中提取目标API接口的接口信息；

根据所述当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句。

6.根据权利要求5所述的方法，其特征在于，所述根据所述当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句，包括：

根据当前数据请求和目标API接口的接口信息，确定SQL查询语句的入参数据；

根据所述目标API接口对应的SQL查询语句模板和所述入参数据，生成SQL查询语句。

7.一种API接口生成装置，其特征在于，包括：

第一获取模块，用于获取当前数据请求对应的SQL查询语句；

第一确定模块，用于根据所述SQL查询语句的语义信息，确定目标数据的数据类型；

生成模块，用于根据所述目标数据的数据类型，生成所述SQL查询语句对应的API接口。

8.一种API接口调用装置，其特征在于，包括：

第二获取模块，用于获取当前数据请求和API接口文档；

第二确定模块，用于根据所述当前数据请求，确定目标API接口；

调用模块，用于从所述API接口文档中提取目标API接口的接口信息；

查询模块，用于根据所述当前数据请求和目标API接口的接口信息，生成当前数据请求对应的SQL查询语句。

9.一种电子设备，其特征在于，包括：至少一个处理器和存储器；

所述存储器存储计算机执行指令；

所述至少一个处理器执行所述存储器存储的计算机执行指令，使得所述至少一个处理器执行如权利要求1至4任一项所述的方法或权利要求5或6所述的方法。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质中存储有计算机执行指令，当处理器执行所述计算机执行指令时，实现如权利要求1至4任一项所述的方法或权利要求5或6所述的方法。

Images