CN106325870A - 一种动态表单api接口的实现方法及装置 - Google Patents

Abstract

本发明公开了一种动态表单API接口的实现方法及装置，通过接收用户由统一接口输入的表单操作数据；获取表单操作数据的单据类型；根据单据类型获取与单据类型对应的模板信息；根据模板信息以及表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。本发明所提供的动态表单API接口的实现方法及装置，在不同的单据情况下，只需要一个统一的API接口，大大缩减了代码量，方便了使用者以及开发者，降低了人力成本、物力成本，同时减轻了维护的困难。

Description

一种动态表单API接口的实现方法及装置

技术领域

本发明涉及动态表单技术领域，特别是涉及一种动态表单API接口的实现方法及装置。

背景技术

现有技术中，对于API接口的提供都是通过定制化开发。不同的表单由于表结构的不同以及业务逻辑的不同，需要开发不同的接口。

不同的表单对应开发不同的接口，这需要耗费巨大的人力、物力；要想实现不同的单据、不同的内容，必须重新开发接口，加大了开发过程的代码量，同时维护起来也比较困难。

因此，提供一种在不同单据情况下，统一进行调用的接口是本领域技术人员亟待解决的技术问题。

发明内容

本发明的目的是提供一种动态表单API接口的实现方法及装置，以解决现有技术中不同的单据需要不同的API接口，导致人力物力资源的浪费、开发成本以及维护成本较高的问题。

为解决上述技术问题，本发明提供一种动态表单API接口的实现方法，包括：

接收用户由统一接口输入的表单操作数据；

获取所述表单操作数据的单据类型；

根据所述单据类型获取与所述单据类型对应的模板信息；

根据所述模板信息以及所述表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。

可选地，所述模板信息至少包括单据的表名、字段以及逻辑验证数据。

可选地，所述表单操作数据包括保存、新增、修改、删除或查询操作对应的数据。

可选地，所述表单操作数据为JSON格式数据。

可选地，在所述接收用户由统一接口输入的表单操作数据之后还包括：

对接收到的JSON数据进行解析。

可选地，在所述根据所述模板信息以及所述表单操作数据构建单据之后还包括：

对所述JSON数据是否符合单据类型对应的模板信息进行格式验证；

和/或对用户执行操作的权限进行验证；

和/或对数据的有效性进行验证。

可选地，所述执行相应的操作包括：

构建sql，进行sql的更新或插入的操作。

可选地，所述返回调用结果包括：

若调用成功，则返回调用成功的标示信息；

若调用失败，则将失败原因以JSON格式返回。

可选地，在所述完成对API接口的调用之后还包括：

对表单进行统一保存处理。

本发明还提供了一种动态表单API接口的实现装置，包括：

表单操作数据接收模块，用于接收用户由统一接口输入的表单操作数据；

单据类型获取模块，用于获取所述表单操作数据的单据类型；

模板信息获取模块，用于根据所述单据类型获取与所述单据类型对应的模板信息；

调用模块，用于根据所述模板信息以及所述表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。

本发明所提供的动态表单API接口的实现方法及装置，通过接收用户由统一接口输入的表单操作数据；获取表单操作数据的单据类型；根据单据类型获取与单据类型对应的模板信息；根据模板信息以及表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。本发明所提供的动态表单API接口的实现方法及装置，在不同的单据情况下，只需要一个统一的API接口，大大缩减了代码量，方便了使用者以及开发者，降低了人力成本、物力成本，同时减轻了维护的困难。

附图说明

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

图1为本发明所提供的动态表单API接口的实现方法的一种具体实施方式的流程图；

图2为本发明所提供的动态表单API接口的实现方法的另一种具体实施方式的流程图；

图3为本发明所提供的动态表单API接口的实现方法的另一种具体实施方式的示意图；

图4为本发明实施例提供的动态表单API接口的实现装置的结构框图。

具体实施方式

为了使本技术领域的人员更好地理解本发明方案，下面结合附图和具体实施方式对本发明作进一步的详细说明。显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

本发明所提供的动态表单API接口的实现方法的一种具体实施方式的流程图如图1所示，该方法包括：

步骤S101：接收用户由统一接口输入的表单操作数据；

步骤S102：获取所述表单操作数据的单据类型；

步骤S103：根据所述单据类型获取与所述单据类型对应的模板信息；

步骤S104：根据所述模板信息以及所述表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。

本发明所提供的动态表单API接口的实现方法，通过接收用户由统一接口输入的表单操作数据；获取表单操作数据的单据类型；根据单据类型获取与单据类型对应的模板信息；根据模板信息以及表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。本发明所提供的动态表单API接口的实现方法，在不同的单据情况下，只需要一个统一的API接口，大大缩减了代码量，方便了使用者以及开发者，降低了人力成本、物力成本，同时减轻了维护的困难。

在上述实施例中，模板信息至少包括单据的表名、字段以及逻辑验证数据。当然还可以包括其他数据，并不限于这几种。表单操作数据可以具体包括保存、新增、修改、删除或查询操作对应的数据。

需要指出的是，本申请在底层构建了一套完整的模板数据，将单据字段、表名、逻辑验证保存至模板中，通过单据类型可获取该单据数据模板。基于该数据模板，可以动态还原该单据结构，在程序中可通过该模板信息实例化出表单数据。在不同的单据情况下，只需要一个统一的API接口，比如保存、修改，不管单据类型，只需统一一个保存接口和修改接口。

动态API接口提供了单据类型ID参数，调用者在调用接口时必须传入单据类型ID，然后系统通过该ID获取该单据模板信息，比如该单据要保存的表名、表字段以及哪些字段是不能为空，所以动态API接口就可根据该单据类型ID实例化出该单据类型的单据模型出来。

以保存接口为例，用户提供JSON数据，该JSON数据以模板结构序列化而成，接口内部将该JSON数据反序列化成单据模板，进而实现对该模板单据的保存，接口调用者无需关注该单据类型，开发者也无需为不同类型单据开发不同接口。

表单操作数据可以具体为JSON格式数据。在步骤S101接收用户由统一接口输入的表单操作数据之后还可以包括：

对接收到的JSON数据进行解析。

在上述任一实施例的基础上，本发明所提供的动态表单API接口的实现方法，在根据所述模板信息以及所述表单操作数据构建单据之后还可以包括：逻辑验证的过程。具体可以包括：对所述JSON数据是否符合单据类型对应的模板信息进行格式验证；和/或对用户执行操作的权限进行验证；和/或对数据的有效性进行验证。

本发明所提供的动态表单API接口的实现方法的另一种具体实施方式的流程图如图2所示，该方法包括：

步骤S201：接收用户由统一接口输入的表单操作数据；

表单操作数据中包含单据类型ID。

步骤S202：对接收到的JSON数据进行解析；

步骤S203：获取所述表单操作数据的单据类型；

步骤S204：根据所述单据类型获取与所述单据类型对应的模板信息；

模板信息可以具体包括：单据的表名、表字段以及哪些字段是不能为空，根据该信息可构建出该单据的具体结构。

步骤S205：根据所述模板信息以及所述表单操作数据构建单据；

步骤S206：对所述JSON数据是否符合单据类型对应的模板信息进行格式验证；

JSON格式验证指是否符合该单据类型模板，比如该单据模板中需要的字段，该JSON中是否存在。

步骤S207：对用户执行操作的权限进行验证；

功能权限验证是指调用者在调用新增、修改、删除时，调用者是否有权限做新增、修改、删除的操作。

步骤S208：对数据的有效性进行验证；

数据有效性验证是指比如某些字段在保存时必须要有值，而JSON中该字段没有值，则该JSON无效。

步骤S209：验证通过后，执行相应的操作并返回调用结果，完成对API接口的调用。

验证完成后，构建sql，进行sql的更新或插入的操作。

本实施例中返回调用结果的过程可以具体包括：

若调用成功，则返回调用成功的标示信息；若调用失败，则将失败原因以JSON格式返回。当然也可以以其他格式返回数据，这个可以由开发者自行定义，并不影响本发明的实现。

具体地，根据接口方法调用的不同返回对应不同的数据。

比如：执行新增操作时：返回新增是否成功的标示。如果成功，则返回新增的单据ID；如果失败，则返回失败的原因。

执行修改的操作时：返回修改是否成功的标示。如果成功，则返回修改的单据ID；如果失败，则返回失败的原因。

执行删除的操作时：返回删除是否成功的标示。如果成功，则返回删除的单据ID；如果失败，则返回失败的原因。

执行查询的操作时：返回查询是否成功的标示。如果成功，则返回查询的结果；如果失败，则返回失败的原因。

其中，查询提供单据明细查询，调用者传入单据ID，返回该单据的所有字段信息。

进一步地，在所述完成对API接口的调用的步骤之后还可以包括：

对表单进行统一保存处理。

如图3本发明所提供的动态表单API接口的实现方法的另一种具体实施方式的示意图所示，本发明所提供的方法中统一接口层为不分单据类型的统一的接口，例如不管多少种单据，新增、修改、删除、查询，就只有4个接口，但现有技术中则每种单据需要提供4种接口，可见本申请大大减少了调用的接口数量。

不管任何类型单据，任何接口都会调用到中转层，中转层根据单据类型ID在此进行中转，根据单据类型ID进行单据模板的初始化，然后根据单据类型ID进行不同的业务操作的处理。比如出库单要进行库存的扣减，采购订单要进行库存的增加，这些都是根据单据类型ID来判断，不同的单据类型进行不同的业务处理。

优选地，如图3所示，本申请还可以预留保存接口，用户可在接口中实现自己各种个性化业务。比如有客户需要在保存完成后统一发送邮件，客户可以自己在该接口中开发。

下面对本发明实施例提供的动态表单API接口的实现装置进行介绍，下文描述的动态表单API接口的实现装置与上文描述的动态表单API接口的实现方法可相互对应参照。

图4为本发明实施例提供的动态表单API接口的实现装置的结构框图，参照图4动态表单API接口的实现装置可以包括：

表单操作数据接收模块100，用于接收用户由统一接口输入的表单操作数据；

单据类型获取模块200，用于获取所述表单操作数据的单据类型；

模板信息获取模块300，用于根据所述单据类型获取与所述单据类型对应的模板信息；

调用模块400，用于根据所述模板信息以及所述表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。

本发明所提供的动态表单API接口的实现装置，通过接收用户由统一接口输入的表单操作数据；获取表单操作数据的单据类型；根据单据类型获取与单据类型对应的模板信息；根据模板信息以及表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。本发明所提供的动态表单API接口的实现装置，在不同的单据情况下，只需要一个统一的API接口，大大缩减了代码量，方便了使用者以及开发者，降低了人力、物力成本，减轻了维护的困难

本说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其它实施例的不同之处，各个实施例之间相同或相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

专业人员还可以进一步意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、计算机软件或者二者的结合来实现，为了清楚地说明硬件和软件的可互换性，在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本发明的范围。

结合本文中所公开的实施例描述的方法或算法的步骤可以直接用硬件、处理器执行的软件模块，或者二者的结合来实施。软件模块可以置于随机存储器(RAM)、内存、只读存储器(ROM)、电可编程ROM、电可擦除可编程ROM、寄存器、硬盘、可移动磁盘、CD-ROM、或技术领域内所公知的任意其它形式的存储介质中。

以上对本发明所提供的动态表单API接口的实现方法以及装置进行了详细介绍。本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想。应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以对本发明进行若干改进和修饰，这些改进和修饰也落入本发明权利要求的保护范围内。

Claims (10)

1.一种动态表单API接口的实现方法，其特征在于，包括：

接收用户由统一接口输入的表单操作数据；

获取所述表单操作数据的单据类型；

根据所述单据类型获取与所述单据类型对应的模板信息；

根据所述模板信息以及所述表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。

2.如权利要求1所述的动态表单API接口的实现方法，其特征在于，所述模板信息至少包括单据的表名、字段以及逻辑验证数据。

3.如权利要求2所述的动态表单API接口的实现方法，其特征在于，所述表单操作数据包括保存、新增、修改、删除或查询操作对应的数据。

4.如权利要求3所述的动态表单API接口的实现方法，其特征在于，所述表单操作数据为JSON格式数据。

5.如权利要求4所述的动态表单API接口的实现方法，其特征在于，在所述接收用户由统一接口输入的表单操作数据之后还包括：

对接收到的JSON数据进行解析。

6.如权利要求1至5任一项所述的动态表单API接口的实现方法，其特征在于，在所述根据所述模板信息以及所述表单操作数据构建单据之后还包括：

对所述JSON数据是否符合单据类型对应的模板信息进行格式验证；

和/或对用户执行操作的权限进行验证；

和/或对数据的有效性进行验证。

7.如权利要求6所述的动态表单API接口的实现方法，其特征在于，所述执行相应的操作包括：

构建sql，进行sql的更新或插入的操作。

8.如权利要求7所述的动态表单API接口的实现方法，其特征在于，所述返回调用结果包括：

若调用成功，则返回调用成功的标示信息；

若调用失败，则将失败原因以JSON格式返回。

9.如权利要求8所述的动态表单API接口的实现方法，其特征在于，在所述完成对API接口的调用之后还包括：

对表单进行统一保存处理。

10.一种动态表单API接口的实现装置，其特征在于，包括：

表单操作数据接收模块，用于接收用户由统一接口输入的表单操作数据；

单据类型获取模块，用于获取所述表单操作数据的单据类型；

模板信息获取模块，用于根据所述单据类型获取与所述单据类型对应的模板信息；

调用模块，用于根据所述模板信息以及所述表单操作数据构建单据，执行相应的操作并返回调用结果，完成对API接口的调用。