一种API自动生成系统的制作方法

一种api自动生成系统
技术领域
1.本技术涉及数据接口开发领域，具体涉及一种api（application program interface，应用程序接口）自动生成系统。


背景技术：

2.当前，在调用数据库中的数据或与数据库数据进行交互时，例如对数据库中的数据进行调用、对数据库中数据进行查询以及对数据库中数据进行管理，需要对数据库增加接口。
3.开发人员在对接口进行开发时，对于相同数据库或者不同数据库增加接口命令时，会将数据库的命令添加到数据库的源代码中，再对上述命令添加一个对应的接口，这样，不仅修改起来不方便，且在数据库命令时，要重新对数据库源代码进行修改，由于用户需要使用的数据库命令数量大，需要耗费的资源就比较大，使得命令的获取和管理存在诸多不便。


技术实现要素：

4.针对上述技术问题，本技术提供一种api自动生成系统，能够至少解决上述技术问题之一。
5.本技术采用的技术方案为：本技术实施例提供一种api自动生成系统，包括：通信连接的服务器、存储器和m个数据库；所述服务器包括处理器和存储有计算机程序的存储介质；所述存储器中存储有配置文件；所述处理器与一个或多个显示装置通信连接，用于执行计算机程序，基于所述配置文件在所述显示装置上显示配置页面，所述配置页面包括第一数据源生成按钮和第二数据源生成按钮以及对应的第一api生成按钮和第二api生成按钮；所述处理器还用于在检测到在任一数据源生成按钮被点击时，执行计算机程序以实现如下步骤：s100，在所述显示装置上生成数据源配置界面，所述数据源配置界面用于指示当前操作用户输入对应的数据源配置信息；所述数据源配置信息包括用户需要调用的数据库k的名称、设定的数据源标识、数据源ip、登录数据库k的用户名和密码、数据库k的端口号和数据库k的类型，k的取值为1到m；s200，获取当前数据源配置界面输入的数据源配置信息并基于获取的数据源配置信息在所述配置页面生成对应的数据源列表；s300，在检测到点击的数据源生成按钮对应的api生成按钮被点击时，生成api配置界面，所述api配置界面用于指示当前操作用户输入对应的api配置信息，所述api配置信息包括设定的api名称、设定的数据源标识和查询语句，所述查询语句用于指示调用数据库k的那些数据内容；s400，获取当前api配置界面输入的api配置信息并基于获取的api配置信息在所
述配置页面生成对应的api列表，作为所述数据库k的api。
6.本技术至少具有以下技术效果：在开发人员需要调用某个数据库的数据内容而需要生成相应的api时，只需在配置页面配置相关的信息，利用输入的查询命令即可从数据库中获取对应的信息，能够节约开发人员的api开发时间。
附图说明
7.为了更清楚地说明本技术实施例中的技术方案，下面将对实施例描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本技术的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。
8.图1为本技术实施例提供的api自动生成系统的结构示意图。
具体实施方式
9.下面将结合本技术实施例中的附图，对本技术实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本技术一部分实施例，而不是全部的实施例。基于本技术中的实施例，本领域技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本技术保护的范围。
10.图1为本技术实施例提供的api自动生成系统的结构示意图。如图1所示，本技术实施例提供的api自动生成系统包括：通信连接的服务器、存储器和m个数据库。
11.其中，所述服务器可包括处理器和存储有计算机程序的存储介质。处理器可为现有设备。
12.在本技术实施例中，数据库可包括两大类数据库，例如，rdbms（relational database management system，关系数据库管理系统）数据库和redis（remote dictionary server，远程字典服务）数据库，其中，rdbms数据库可包括现有的多种数据类型，例如，可至少包括mysql、oracle、hive、presto和clickhouse等。其中，每个数据库系统可包括多个数据库，每个数据库中可包括多个数据表，每个数据表存储有不同的数据。数据库、数据表的具体数量可根据实际需求进行设置，每个数据表存储的数据也根据实际需求进行设置。
13.在本技术实施例中，所述存储器中存储有配置文件。所述处理器与一个或多个显示装置1通信连接，用于执行计算机程序，基于所述配置文件在所述显示装置上显示配置页面。具体地，当用户（api开发人员）在所属的显示装置上点击配置页面对应的图标时，处理器加载配置文件生成配置页面并在显示装置上进行显示。本领域技术人员知晓，具体加载方式和显示时现有技术，生成的api与常规的restful api并无区别，可以供前端或者浏览器等直接调用。
14.在本技术实施例中，配置页面用于通过用户操作生成需要查询的数据库所需的api，如图1所示，可包括第一数据源生成按钮2和第二数据源生成按钮3以及对应的第一api生成按钮4和第二api生成按钮5，在一个示意性实施例中，所述第一数据源生成按钮可为rdbms数据源生成按钮或者redis数据源生成按钮，所述第二数据源生成按钮为redis数据源生成按钮或者rdbms数据源生成按钮。所述第一api生成按钮可为sql api生成按钮或者redis api生成按钮，所述第二api生成按钮可为redis api生成按钮或者sql api生成按
钮。在本技术实施例中，数据源为能够查询到数据库的链接信息。
15.在实际应用中，在配置页面中，rdbms数据源生成按钮以“添加rdbms数据源”的形式呈现，redis数据源生成按钮。sql api生成按钮会以“sql api”的形式呈现，redis api生成按钮会以“redis api”。用户可基于需要调用的数据库来选择对应的数据源生成按钮和api生成按钮。例如，需要生成一个mysql的数据库的api，则可选择rdbms数据源生成按钮和sql api生成按钮来进行配置。
16.具体地，例如，在用户点击rdbms数据源生成按钮时，会生成数据源配置界面，数据源配置界面上会呈现需要输入的信息包括数据库名称、数据源名称、数据源ip、用户名、密码、端口号和数据类型，其中，数据库名称为需要查询的实际数据库名称，数据源名称为用户为查询的数据库定义的名称，可称作设定的数据源标识，数据源ip为安装需要查询的数据库的服务器的安装地址，用户名和密码为用户登录到查询的数据库的账号和密码，端口号为需要查询的数据库的端口号，数据类型为需要查询的数据库的类型。在数据源配置界面输入完配置信息时，用户可点击对应的api生成按钮，在点击之后，会生成api配置界面，api配置界面会呈现需要输入的信息包括api名称、设定的数据源标识和查询语句。api名称为用户自定义的名称。查询语句用于指示需要查询数据库的那些数据内容，查询语句可为sql语句或者redis语句，可基于需要查询的数据库的类型进行确定。查询语句的具体内容可根据需要查询的数据内容确定。
17.在本技术实施例中，所述处理器还用于基于用户在配置页面输入的配置信息生成对应的结果。更详细地，所述处理器还用于在检测到在任一数据源生成按钮被点击时，执行计算机程序以实现如下步骤：s100，在所述显示装置上生成数据源配置界面，所述数据源配置界面用于指示当前操作用户输入对应的数据源配置信息；所述数据源配置信息包括用户需要调用的数据库k的名称、设定的数据源标识、数据源ip、登录数据库k的用户名和密码、数据库k的端口号和数据库k的类型，k的取值为1到m。
18.在本技术实施例中，数据库k的名称为数据库中的真实名称，设定的数据源标识为用户自定义的名称，与数据库k的名称不相同，以便于与数据库k的名称区分。例如，对于数据库eam，对应的数据源标识可为112-eam。这样，不同的用户可生成具有不同数据源标识的数据源，即同一个数据库，可生成多个数据源，而用户可以基于每个数据源生成多个api。
19.数据源ip是指安装数据库k的服务器的安装地址，数据库k的类型可基于数据库k所属的类型进行选择，例如，如果是mysql，则输入mysql。
20.s200，获取当前数据源配置界面输入的数据源配置信息并基于获取的数据源配置信息在所述配置页面生成对应的数据源列表。
21.生成的数据源列表即为数据库k的链接信息。在一个示意性实施例中，数据源列表可包括数据库名称、设定的数据源标识、数据源ip、数据库的类型、用户名和操作按钮，操作按钮可包括修改和删除按钮，以方便用户修改和删除数据源。
22.s300，在检测到点击的数据源生成按钮对应的api生成按钮被点击时，生成api配置界面，所述api配置界面用于指示当前操作用户输入对应的api配置信息，所述api配置信息包括设定的api名称、设定的数据源标识和查询语句，所述查询语句用于指示调用数据库k的那些数据内容。
23.在本技术实施例中，可获取数据库k中某个数据表中的数据内容，也可以同时获取数据库k中的多个数据内容，即数据内容可包括一个数据表中的数据或者多个数据表中的数据。
24.s400，获取当前api配置界面输入的api配置信息并基于获取的api配置信息在所述配置页面生成对应的api列表，作为所述数据库k的api。
25.在本技术实施例中，所述api列表可包括api名称、设定的数据源标识、查询语句和请求路径，所述请求路径与api名称、设定的数据源标识、查询语句相关联。在一个示意性实施例中，所述api列表中还包括执行按钮，通过点击执行按钮获取到对应的数据内容。具体地，在用户点击执行按钮时，处理器会将该请求路径中的查询语句放入到对应的代码中执行，以获取与查询语句对应的查询结果，并返回给配置页面进行显示。
26.在另一个示意性实施例中，所述api列表中还包括修改按钮和删除按钮，以便于用户修改和删除生成的api。
27.本技术实施例提供的api自动生成系统，只需要在配置页面进行配置的方式就可以生成对应的接口，对于同一个数据库，可以根据需要生成大量的api，与现有的针对每个接口都需要单独编写代码相比，能够节约接口开发时间。
28.在本技术实施例中，所述系统还与多个客户端通信连接，每个客户端可通过所述请求路径获取对应的数据内容。例如，客户端可通过请求某个api的请求路径的得到对应的数据内容。
29.虽然已经通过示例对本技术的一些特定实施例进行了详细说明，但是本领域的技术人员应该理解，以上示例仅是为了进行说明，而不是为了限制本技术的范围。本领域的技术人员还应理解，可以对实施例进行多种修改而不脱离本技术的范围和精神。本技术公开的范围由所附权利要求来限定。

技术特征：
1.一种api自动生成系统，其特征在于，所述系统包括：通信连接的服务器、存储器和m个数据库；所述服务器包括处理器和存储有计算机程序的存储介质；所述存储器中存储有配置文件；所述处理器与一个或多个显示装置通信连接，用于执行计算机程序，基于所述配置文件在所述显示装置上显示配置页面，所述配置页面包括第一数据源生成按钮和第二数据源生成按钮以及对应的第一api生成按钮和第二api生成按钮；所述处理器还用于在检测到在任一数据源生成按钮被点击时，执行计算机程序以实现如下步骤：s100，在所述显示装置上生成数据源配置界面，所述数据源配置界面用于指示当前操作用户输入对应的数据源配置信息；所述数据源配置信息包括用户需要调用的数据库k的名称、设定的数据源标识、数据源ip、登录数据库k的用户名和密码、数据库k的端口号和数据库k的类型，k的取值为1到m；s200，获取当前数据源配置界面输入的数据源配置信息并基于获取的数据源配置信息在所述配置页面生成对应的数据源列表；s300，在检测到点击的数据源生成按钮对应的api生成按钮被点击时，生成api配置界面，所述api配置界面用于指示当前操作用户输入对应的api配置信息，所述api配置信息包括设定的api名称、设定的数据源标识和查询语句，所述查询语句用于指示调用数据库k的那些数据内容；s400，获取当前api配置界面输入的api配置信息并基于获取的api配置信息在所述配置页面生成对应的api列表，作为所述数据库k的api。2.根据权利要求1所述的系统，其特征在于，所述api列表包括api名称、设定的数据源标识、查询语句和请求路径，所述请求路径与api名称、设定的数据源标识、查询语句相关联。3.根据权利要求2所述的系统，其特征在于，所述api列表中还包括执行按钮，通过点击执行按钮获取到对应的数据内容。4.根据权利要求2所述的系统，其特征在于，所述api列表中还包括修改按钮和删除按钮。5.根据权利要求2所述的系统，其特征在于，所述系统还与多个客户端通信连接，每个客户端通过所述请求路径获取对应的数据内容。6.根据权利要求1所述的系统，其特征在于，设定的数据源标识和对应的数据库的名称不相同。7.根据权利要求1所述的系统，其特征在于，每个数据库包括多个数据表，所述数据内容包括一个数据表中的数据或者多个数据表中的数据。8.根据权利要求1所述的系统，其特征在于，所述第一数据源生成按钮为rdbms数据源生成按钮，所述第二数据源生成按钮为redis数据源生成按钮。9.根据权利要求8所述的系统，其特征在于，所述第一api生成按钮为sql api生成按钮，所述第二api生成按钮为redis api生成按钮。

技术总结
本申请提供了一种API自动生成系统，包括：通信连接的服务器、存储器和m个数据库；存储器中存储有配置文件，处理器基于配置文件在显示装置上显示配置页面，配置页面包括数据源生成按钮和API生成按钮。在需要生成某个数据库的API时，用户可在配置页面输入相应的配置信息就可自动得到对应的API。本申请能够提高API的开发效率。开发效率。开发效率。


技术研发人员：刘秋雨 徐煜东 韩华方
受保护的技术使用者：宜科（天津）电子有限公司
技术研发日：2022.02.07
技术公布日：2022/3/8