CN112131294A - 一种快速生成接口的方法、系统及其装置 - Google Patents

Abstract

本发明公开了一种快速生成接口的方法、系统及其装置，涉及大数据应用技术领域。本发明包括根据查询内容，在数据库内搜寻该查询内容对应的数据表；读取数据表表属性信息，根据表属性信息配置请求参数和返回参数；并对请求参数加工进行加工：结合请求参数、返回参数修改通用接口完成接口的配置，运行接口生成接口信息，在使用者调用接口时，生成动态可执行SQL查询语句，访问对应的数据库并返回查询信息。本发明通过提供统一配置生成方式，配置则通过对预设的通用接口进行修，仅是修改配置信息，进而加快了接口配置的速度。

Description

一种快速生成接口的方法、系统及其装置

技术领域

本发明属于大数据应用技术领域，特别是涉及一种快速生成接口的方法、系统及其装置。

背景技术

随着数据量的与日俱增、业务的日渐复杂，一些服务通常采用数据接口以实现访问其它服务的数据；因此，越来越多的接口需求被提出来，传统开发数据资源类接口开发模式单一、工作量大，短时间内无法快速完成开发工作，需要技术人员每次编写接口程序，无法实现复用。此类方法仅能满足用户单一需求，且调用接口时无法实现对接口返回字段内容进行进一步的加工处理，无法实现接口返回内容的个性化定制需求。

发明内容

本发明的目的在于提供一种快速生成接口的方法、系统及其装置，以此加快接口开发效率。

为解决上述技术问题，本发明是通过以下技术方案实现的：

本发明为一种快速生成接口的方法，包括如下步骤：获取用户的数据请求，其中，所述数据请求包括数据内容和业务范围；

获取数据库内与所述数据请求相匹配的数据表；

读取所述数据表的表属性信息，根据所述表属性信息的至少两个字段配置所述数据表的配置请求参数和返回参数，其中，通用参数类型以所述至少两个字段拼接成condition条件参数作为配置请求参数，自定义参数类型以所述至少两个字段作为配置请求参数；

结合所述配置请求参数、返回参数修改通用接口完成所述通用接口的配置。

优选地，所述方法还包括：生成所述通用接口信息，所述通用接口信息包括接口名称、请求地址、请求方式、请求示例、请求参数和返回参数，其中，所述请求参数包括配置请求参数和系统请求参数，所述系统请求参数包括Keyld、order、pagesize、pagenum。

优选地，系统请求参数还包括process字段。

优选地，Key ID根据用户名ID和通用接口ID使用加密工具生成。

优选地，方法还包括：所述请求参数和所述Key ID被配置为SQL语句以用于访问数据库中对应的数据表；

一种快速接口生成系统，包括：

查询模块，于数据库中查询并获取对应数据请求的数据表；

接口信息生成模块，根据请求数据生成对应请求人的接口信息；

配置单元，根据配置的请求参数和返回参数修改通用接口完成通用接口的配置；

请求参数加工单元，请求参数加工单元包括自定义参数类型加工模块和通用参数类型加工模块；

其中，自定义参数类型加工模块以至少两个字段作为配置请求参数；通用参数类型加工模块以所述至少两个字段拼接成condition条件参数作为配置请求参数；

属性信息表生成模块，根据查询数据表属性信息生成对应该数据表的属性信息表格；

预设接口模块，为配置单元提供通用接口模型。

优选地，还包括：

SQL语句模板生成模块，依据配置请求参数和Key ID生成动态生成SQL 查询语句；

加密模块，根据用户名生成对应的加密接口ID。

一种基于数据的快速生成接口装置，装置包括：

通信模块，通信模块采用统一的服务框架；

通用接口服务模块，用于：基于参数配置模块配置参数配合通用接口生成接口服务、基于服务框架接收用户调用接口的请求；

其中，调用请求包括：请求参数，以及唯一性地指向目标数据资源对应的数据库的接口ID；依据接口ID获取参数配置模块的配置信息；

配置信息包括：过滤条件参数、生成SQL语句模板；依据接口调用请求参数和生成SQL语句模板动态生成可执行查询语句；根据可执行查询语句获取查询结果，通过通用接口返回用户端；

参数配置模块，用于提供配置参数信息及生成SQL语句模板.

本发明具有以下有益效果：

本发明为多种数据资源类接口提供统一配置生成方式，将配置生成的接口分配给需求方用户，无需进行代码开发，每次配置通过对预设的通用接口进行修，仅是修改配置信息，极大的加快了接口配置的速度。需求方可以通过调用接口将请求参数替换SQL语句模板的参数占位符，生成可执行SQL查询语句，获取相应的查询结果，无需在每次进行调用接口时分别在代码中编写查询语句，完全根据请求内容由系统动态生成查询语句，因此，能够大大减少代码编写的数量，提高数据资源类接口的开发效率。

当然，实施本发明的任一产品并不一定需要同时达到以上所述的所有优点。

附图说明

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

图1为本发明的一种快速生成接口的方法流程图；

图2为本发明的一种快速生成接口的系统框图；

图3为本发明的一种快速生成接口装置框图；

图4为本发明的一种基于数据的快速生成接口的系统框架。

具体实施方式

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

请参阅图1所示，本发明为一种快速生成接口的方法，系统将完成以下步骤生成接口，相应的，系统的服务框架是通过远程过程调用协议(Remote Procedure CallProtocol，RPC)实现的也可通过超文本传送协议(HyperText Transfer Protocol，HTTP)实现的。HTTP协议是用于从WWW服务器传输超文本到本地浏览器的传送协议，在一些实施例中，基于HTTP协议，可以使用POST法向指定资源提交数据进行处理请求，例如，提交表单，或者使用GET 法向特定的资源发出请求，例如向服务器发送获取数据的请求等。基于HTTP 协议的服务框架可以使浏览器更加高效。

配置信息的存储位置可以根据实际情况进行设置，例如，将配置信息存储在应用系统对应的目标数据库上，依据接口ID从目标数据库获取配置信息；当然，配置信息也可以存储在应用系统内部或者其他具有存储功能的元件上。目标数据库可以为关系型数据库，例如结构化查询语言(Structured Query Language，MYSQL)，或者为非关系型数据库。配置信息可以进一步包括：唯一性地指向接口关联的数据资源对应的目标数据库的数据信息。例如，当目标数据库为关系型数据库时，配置信息可以进一步包括：目标数据库的网络域名或IP，以及库名。通过该数据信息，可以快速定位应用系统对应的目标数据库，从该目标数据库中执行可执行查询语句，获取查询结果。

本发明对接口ID的生成方式和组成不做具体限定，只要其能够唯一性地指向应用系统对应的目标数据库即可。

具体的接口配置步骤：

步骤一、接受并获取用户向数据库发起资源获取请求信息。

其接口是针对客户需求进行搭建的。

在本实施例中，用户若希望获得精准化的资源需求，即将会对需要的数据资源进行描述，进一步的，例如用户需要获取甲公司基本信息表中2017 年至2018年新增人员信息，则需要在发送的请求信息中明确，单位名称、人员姓名，年份、性别、身高、人员所在省份，人员出生日期等具体信息。

可通过创建相对应的接口完成数据的传输，优选的则是针对上述用户的需求，生成对应的接口。

具体的针对性的生成相应接口包括以下步骤：

步骤二、根据查询内容，在数据库内搜寻该查询内容对应的数据表；

在本实施例中，平台则调取用户的请求信息，获取用户对需求资源的描述，后在数据库内进行搜寻，查找相对应的数据表。

步骤三、建立初步联系，将用户所申请表资源与表资源所属数据库建立连接，读取数据表表属性信息，根据表属性信息配置配置请求参数和返回参数。

在本实施例中，表属性信息主要为字段信息，包括其中字段信息包括英文名字段、中文名字段、字段类型字段、描述字段信息，如数据表的名称，数据列表的属性信息，如甲公司基本信息表如表名“2018年新增员工信息表”, 员工“身份证号”列表，通过对以上信息进行获取，并生成表进行展示，以供选取。

返回参数的配置按照现有技术进行配置，这里不在进行详细展开。

步骤四、加工请求参数：勾选查询内容中相应业务信息参数，至少两个字段作为配置请求参数又或者以至少两个字段拼接成condition条件参数作为配置请求参数。

具体的在加工请求参数前：查询数据表属性信息，并生成对应该数据表的属性信息表，对照列表信息进行勾选即可，以“2018年新增员工信息表”为例，相应在横列的标题栏中依次序号、英文字段名、中文字段名、字段类型、字段描述、参数名定义、定义为请求参数、定义未返回参数等相应的对字段参数进行纵向排列。

其中一个具体实施方式：自定义请求参数加工：依照具体的查询内容相应的在生成的属性表内进行选择，更为具体的以请求这需要“2018年新增员工信息表”若需要对人员姓名，年份、性别信息，仅仅在三者对应的勾选框内进行勾选即可，以此作为请求参数的内容，进行精准配置。

令一种加工方式，添加condition条件参数属性生成请求参数，以至少两个字段拼接成condition条件参数作为配置请求参数。

具体的在选择必要字段信息后，将该数据表中常用的表属性信息进行选择，如需要获取2018年新增员工信息表中常规信息，即员工姓名，身份证号或者年龄，将该列表属性通过condition条件语句对，参数属性表属性信息进行拼接，形成带有参数组的SQL请求参数，仅仅需要对需要的参数进行勾选，并在条件语句中进行拼接即可，以此根据常规获取信息简化具体信息即数据列表的属性信息勾选，依次加快接口的搭建。

步骤五，结合配置请求参数、返回参数修改通用接口完成接口的配置。

其中通用接口具有接口的必要配置条件。

在本实施例中，将配置完成的请求参数、返回参数填入通用接口中的空缺位内，以此搭建接口，其可极大的降低接口配置的时长。

相应的通用接口具有请求参数，请求参数包括配置请求参数和系统请求参数，所述系统请求参数包括Keyld、order、pagesize、pagenum；

接口配置完成后分配至不同用户。

步骤六、运行接口，生成接口信息，包含接口名称、请求地址、请求方式、请求示例、请求参数、返回参数属性信息。

其中系统请求参数中的process请求参数为接口返回内容处理参数字段。

步骤七、将接口分发至用户，用户获得配置好的接口调用权限，发起调用接口请求。

具体的，接口生成SQL语句，查询数据库。

更进一步的，接口将请求参数替换SQL语句模板的参数占位符，生成可执行SQL查询语句，访问对应的数据库并返回查询信息，其中，SQL语句是根据业务模型和查询条件动态生成的，其SQL语句动态生成方法，为现有技术，这里不在进行展开。

另外的，Key ID为根据用户名和接口ID使用加密工具生成。

系统运行接口配置信息前，系统生成通用接口连接调用请求，调用请求包含的指定数据源中的数据表，获取表数据信息，接口采用后端代码封装，可使得不同用户的接口调用请求都能通过通用接口连接数据库进行访问，不会生成新的接口，系统通过滤条件对数据表中的非请求数据进行过滤，之后根据请求者的实际请求通过数据比较的方式进行再过滤，过滤接口返回值范围，并提供维护接口名称及摘要信息功能。

如图2所示：一种快速接口生成系统，包括：

查询模块，于数据库中查询并获取对应数据请求的数据表，根据该数据表可获取对应请求内容中数据表的属性信息，为后续的配置请求参数和返回参数的配置提供信息基础；

配置单元，根据配置请求参数和返回参数修改通用接口完成接口的配置；

请求参数加工单元，请求参数加工单元包括自定义参数类型加工模块和通用参数类型加工模块，自定义参数类型加工模块以至少两个字段作为配置请求参数；通用参数类型加工模块以所述至少两个字段拼接成condition条件参数作为配置请求参数。

属性信息表生成模块，根据查询数据表属性信息生成对应该数据表的属性信息表格，根据该属性信息表格以供请求参数加工单元加工配置请求参数时勾选对应请求内容的属性信息。

预设接口模块，为配置单元提供通用接口模型。

接口信息生成模块，根据请求数据生成对应请求人的接口信息，该信息包括接口名称、请求地址、请求方式、请求示例、请求参数、返回参数属性信息，生成可供请求人调用的接口。

SQL语句模板生成模块，依据配置请求参数和Key ID生成动态生成SQL 查询语句，接收接口调用方发送的key ID和查询参数信息获取相应的查询结果。

加密模块，根据用户名生成对应的加密接口ID。

如图3所示：一种基于数据的快速生成接口装置，装置包括：

通信模块，通信模块采用统一的服务框架；

通用接口服务模块，用于：基于参数配置模块配置参数配合通用接口生成接口服务、基于服务框架接收用户调用接口的请求；

其中，调用请求包括：请求参数，以及唯一性地指向目标数据资源对应的数据库的接口ID；依据接口ID获取参数配置模块的配置信息；

配置信息包括：过滤条件参数、生成SQL语句模板；依据接口调用请求参数和生成SQL语句模板动态生成可执行查询语句；根据可执行查询语句获取查询结果，通过通用接口返回用户端；

参数配置模块，用于提供配置参数信息及生成SQL语句模板.

如图4所示：一种基于数据的快速生成接口的系统框架，系统架构400 可以包括浏览器web页面401、服务器402和数据库403。

用户可以使用浏览器web页面401通过网络与服务器402交互，以接收或发送消息等。

浏览器web页面401可以是具有显示屏并且支持网页浏览的各种电子设备，包括但不限于平板电脑和台式计算机等等。

服务器402可以是提供各种服务的服务器，例如对用户利用浏览器web 页面401所浏览的网站提供支持的后台管理服务器。后台管理服务器可以对接收到的系统查询请求等数据进行分析等处理，并将处理结果反馈给浏览器 web页面401。

需要说明的是，本发明实施例所提供的基于数据的快速生成接口方法和装置一般由服务器402执行，相应地，基于数据的快速生成接口方法和装置一般设置于服务器402中，该装置的系统运行数据存储在数据库403中。

应该理解，图4中的浏览器web页面、数据库和服务器的数目仅仅是示意性的。根据实现需要，可以具有任意数目的终端设备、网络和服务器

值得注意的是，上述系统实施例中，所包括的各个单元只是按照功能逻辑进行划分的，但并不局限于上述的划分，只要能够实现相应的功能即可；另外，各功能单元的具体名称也只是为了便于相互区分，并不用于限制本发明的保护范围。

另外，本领域普通技术人员可以理解实现上述各实施例方法中的全部或部分步骤是可以通过程序来指令相关的硬件来完成，相应的程序可以存储于一计算机可读取存储介质中，所述的存储介质，如ROM/RAM、磁盘或光盘等。

以上公开的本发明优选实施例只是用于帮助阐述本发明。优选实施例并没有详尽叙述所有的细节，也不限制该发明仅为所述的具体实施方式。显然，根据本说明书的内容，可作很多的修改和变化。本说明书选取并具体描述这些实施例，是为了更好地解释本发明的原理和实际应用，从而使所属技术领域技术人员能很好地理解和利用本发明。本发明仅受权利要求书及其全部范围和等效物的限制。

Claims (9)

1.一种快速生成接口的方法，其特征在于，包括如下步骤：

获取用户的数据请求，其中，所述数据请求包括数据内容和业务范围；

获取数据库内与所述数据请求相匹配的数据表；

读取所述数据表的表属性信息，根据所述表属性信息的至少两个字段配置所述数据表的配置请求参数和返回参数，其中，通用参数类型以所述至少两个字段拼接成condition条件参数作为配置请求参数，自定义参数类型以所述至少两个字段作为配置请求参数；

结合所述配置请求参数、返回参数修改通用接口完成所述通用接口的配置。

2.根据权利要求1所述的一种快速生成接口的方法，其特征在于，所述方法还包括：生成所述通用接口信息，所述通用接口信息包括接口名称、请求地址、请求方式、请求示例、请求参数和返回参数，其中，所述请求参数包括配置请求参数和系统请求参数，所述系统请求参数包括Keyld、order、pagesize、pagenum。

3.根据权利要求2所述的一种快速生成接口的方法，其特征在于，所述系统请求参数还包括process字段。

4.根据权利要求2所述的一种快速生成接口的方法，其特征在于，所述Key ID根据用户名ID和通用接口ID使用加密工具生成。

5.根据权利要求2-4任一项所述的一种快速生成接口的方法，其特征在于，所述方法还包括：所述请求参数和所述Key ID被配置为SQL语句以用于访问数据库中对应的数据表。

6.根据权利要求1所述的一种快速生成接口的方法，其特征在于，所述字段包括英文名字段、中文名字段、字段类型字段、描述字段。

7.一种快速接口生成系统，其特征在于，包括：

查询模块，于数据库中查询并获取对应数据请求的数据表；

接口信息生成模块，根据请求数据生成对应请求人的接口信息；

配置单元，根据配置请求参数和返回参数修改通用接口完成通用接口的配置；

请求参数加工单元，请求参数加工单元包括自定义参数类型加工模块和通用参数类型加工模块；

其中，自定义参数类型加工模块以至少两个字段作为配置请求参数；通用参数类型加工模块以所述至少两个字段拼接成condition条件参数作为配置请求参数；

属性信息表生成模块，根据查询数据表属性信息生成对应该数据表的属性信息表格；

预设接口模块，为配置单元提供通用接口模型。

8.根据权利要求8所述的一种快速接口生成系统，其特征在于，还包括：

SQL语句模板生成模块，依据配置请求参数和Key ID生成动态生成SQL查询语句；

加密模块，根据用户名生成对应的加密接口ID。

9.一种基于数据的快速生成接口装置，其特征在于，装置(300)包括：

通信模块(301)，通信模块(301)采用统一的服务框架；

通用接口服务模块(302)，用于：基于参数配置模块配置参数配合通用接口生成接口服务、基于服务框架接收用户调用接口的请求；

其中，调用请求包括：请求参数，以及唯一性地指向目标数据资源对应的数据库的接口ID；依据接口ID获取参数配置模块的配置信息；

配置信息包括：过滤条件参数、生成SQL语句模板；依据接口调用请求参数和生成SQL语句模板动态生成可执行查询语句；根据可执行查询语句获取查询结果，通过通用接口返回用户端；

参数配置模块(303)，用于提供配置参数信息及生成SQL语句模板。

Images