CN110941950A - 接口文档的生成方法、装置、服务器及存储介质 - Google Patents

Abstract

本申请提供一种接口文档的生成方法、装置、服务器及存储介质，涉及数据处理技术领域。该方法包括通过服务器获取脚本对象符号形式的接口文档；对脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；根据表格实体，得到文字形式的接口文档。通过对脚本对象符号形式的接口文档，进行解析，形成便于前端开发人员参考的文字形式的接口文档，提高了形成文字形式接口文档时的效率，节省了一定的人力资源，也便于对文字形式的接口文档更新。

Description

接口文档的生成方法、装置、服务器及存储介质

技术领域

本发明涉及数据处理技术领域，具体而言，涉及一种接口文档的生成方法、装置、设备及存储介质。

背景技术

通常的项目研发可以包括前端研发和后端研发，后端需要为前端提供接口文档，以便前端可以根据接口文档完成相应的程序编写，因此，对于接口文档的编写变得越来越重要。

相关技术中，通过人工采用接口文档模板，根据网页应用开发前端和后端接口定义，以及对应的规范，手动编写文字形式的接口文档。

但是，相关技术中，通过人工手动编写文字形式的接口文档，会出现编写效率过低的问题，也浪费了不必要的人力资源。

发明内容

本发明的目的在于，针对上述现有技术中的不足，提供一种接口文档的生成方法、装置、服务器及存储介质，以解决相关技术中，通过人工手动编写文字形式的接口文档，会出现编写效率过低的问题，也浪费了不必要的人力资源的问题。

为实现上述目的，本发明实施例采用的技术方案如下：

第一方面，本发明实施例提供了一种网页应用系统中接口文档的生成方法，包括：

获取脚本对象符号形式的接口文档；

对所述脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；

根据所述表格实体，得到文字形式的接口文档。

进一步地，所述表格实体包括：封装后的多个对象；所述将解析得到的接口表，封装成表格实体，包括：

将所述接口表封装为一个对象；

根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象。

进一步地，所述预设的参数划分规则为请求参数和响应参数的划分规则；所述根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象，包括：

将所述接口表中的请求参数和响应参数，分别封装为一个对象。

进一步地，所述根据所述表格实体，得到文字形式的接口文档，包括：

根据所述表格实体，形成超文本标记语言HTML页面形式的接口文档；

将所述HTML页面形式的接口文档，转换成所述文字形式的接口文档。

进一步地，所述根据所述表格实体，形成超文本标记语言HTML页面形式的接口文档，包括：

根据预设的文字形式文档的表格模板，生成空白HTML页面，所述空白HTML页面包括：与所述表格模板相同的列表集合；

采用所述表格实体中的参数，对所述列表集合进行遍历，以将所述表格实体中的参数写入所述列表集合中对应位置，得到所述HTML页面形式的接口文档。

进一步地，所述根据所述表格实体，得到文字形式的接口文档，包括：

根据所述表格实体，调用预设的文字形式的文档生成接口，生成所述文字形式的接口文档。

进一步地，所述根据所述表格实体，调用预设的文字形式的文档生成接口，生成所述文字形式的接口文档之前，所述方法还包括：

生成所述文档生成接口。

第二方面，本申请实施例还提供一种网页应用系统中接口文档的生成装置，包括：

第一获取模块，用于获取脚本对象符号形式的接口文档；

解析模块，用于对所述脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；

第二获取模块，用于根据所述表格实体，得到文字形式的接口文档。

进一步地，所述表格实体包括：封装后的多个对象；所述解析模块，具体用于将所述接口表封装为一个对象；根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象。

进一步地，所述预设的参数划分规则为请求参数和响应参数的划分规则；所述所述解析模块，还具体用于将所述接口表中的请求参数和响应参数，分别封装为一个对象。

进一步地，所述第二获取模块，具体用于根据所述表格实体，形成超文本标记语言HTML页面形式的接口文档；将所述HTML页面形式的接口文档，转换成所述文字形式的接口文档。

进一步地，所述所述第二获取模块，还具体用于根据预设的文字形式文档的表格模板，生成空白HTML页面，所述空白HTML页面包括：与所述表格模板相同的列表集合；采用所述表格实体中的参数，对所述列表集合进行遍历，以将所述表格实体中的参数写入所述列表集合中对应位置，得到所述HTML页面形式的接口文档。

进一步地，所述根据所述二获取模块，还具体用于根据所述表格实体，调用预设的文字形式的文档生成接口，生成所述文字形式的接口文档。

进一步地，所述装置还包括：

生成模块，用于生成所述文档生成接口。

第三方面，本申请实施例还提供一种服务器，包括：存储器和处理器，所述存储器存储有所述处理器可执行的计算机程序，所述处理器执行所述计算机程序时实现上述第一方面所提供的任一所述的方法。

第四方面，本申请实施例还提供一种存储介质，所述存储介质上存储有计算机程序，所述计算机程序被读取并执行时，实现上述第一方面所提供的任一所述的方法。

本申请的有益效果是：本发明实施例提供一种网页应用系统中接口文档的生成方法，通过服务器获取脚本对象符号形式的接口文档；对脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；根据表格实体，得到文字形式的接口文档。通过对脚本对象符号形式的接口文档，进行解析，形成便于前端开发人员参考的文字形式的接口文档，提高了形成文字形式接口文档时的效率，节省了一定的人力资源，也便于对文字形式的接口文档更新。

附图说明

为了更清楚地说明本发明实施例的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，应当理解，以下附图仅示出了本发明的某些实施例，因此不应被看作是对范围的限定，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他相关的附图。

图1为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图；

图2为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图；

图3为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图；

图4为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图；

图5为本发明提供的一种网页应用系统中接口文档的生成装置的结构示意图；

图6为本发明提供的一种服务器的结构示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。

如下通过多个实例对本申请所提供的网页应用系统中接口文档的生成方法进行示例说明。

图1为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图，如图1所示，该网页应用系统中接口文档的生成方法可由服务器通过软件和/或硬件的方式实现。如图1所示，该方法可以包括：

S101、获取脚本对象符号形式的接口文档。

其中，当编写程序代码的语言类型为JAVA时，脚本对象符号形式的接口文档可以为JSON(JavaScriptObjectNotation)格式的接口文档，其中，JSON为一种轻量级的数据交换格式。

在一种可能的实施方式中，服务器中可以具有待生成接口文档的目标程序代码，服务器可以在目标程序代码中添加注释信息，得到添加注释信息后的目标程序代码，服务器中还可以配置有预设框架，服务器可以通过该预设框架将添加注释信息后的目标程序代码，转换为脚本对象符号形式的接口文档，实现服务器获取脚本对象符号形式的接口文档。

例如，预设框架可以为swagger框架，swagger为API(Application ProgrammingInterface，应用程序编程接口)开发框架，当预设框架为swagger框架时，服务器可以根据springfox-swagger组件生成JSON格式的接口文档，即脚本对象符号形式的接口文档。

需要说明的是，服务器可以通过该预设框架将添加注释信息后的目标程序代码，转换为脚本对象符号形式的接口文档时，可以用户在终端进行相应的测试，并根据测试结果调整目标程序代码的注释信息，以形成最终的脚本对象符号形式的接口文档。

S102、对脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体。

其中，接口文档中可以包括多个接口的描述信息。多个接口的描述信息可以包括但不限于：请求参数、返回参数、发送验证码等。发送验证码中可以包括：URL(UniformResourceLocator，统一资源定位器)请求方式、返回值类型等。

在一些实施方式中，服务器可以根据预设解析程序，对脚本对象符号形式的接口文档进行解析，得到接口表，该接口表可以包括每个接口对应的多个描述信息，服务器可以对每个接口，以及接口对应的描述信息进行封装，得到封装后的表格实体，即用于生成接口文档的信息。

在一种可能的实施方式中，服务器在进行解析时，可以解析请求方式“post”，请求的路径“/api/regulator/file/upload”，可以通过“parameters”：[…]，来请求接口的请求参数和返回参数，通过“responses”：{}，请求接口的状态码，以及状态码对应的描述和说明等。当然也可以采用其他方式对脚本对象符号形式的接口文档进行解析，本发明实施例对此不进行具体限制。

例如，URL可以为：/admin/driver/send.yueyue，请求方式可以为：get/post，返回值类型可以为：application/json。

S103、根据表格实体，得到文字形式的接口文档。

其中，接口文档可以为能够在应用程序界面上显示的接口文档，也可以为便于存储的接口文档，例如word格式的接口文档。服务器还可以同时生成能够在应用程序界面上显示的接口文档，以及便于存储的接口文档。

当然，服务器还可以生成其他形式的接口文档，本发明实施例对此不进行具体限制。

在一种可能的实施方式中，服务器中预设有接口文档类型，服务器可以根据该接口文档类型，采用对应的生成规则，生成对应的类型的接口文档，以便于前端研发人员参照此接口文档。其中，接口文档的类型可以包括至少一种。

综上所述，本发明实施例提供一种网页应用系统中接口文档的生成方法，通过服务器获取脚本对象符号形式的接口文档；对脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；根据表格实体，得到文字形式的接口文档。通过对脚本对象符号形式的接口文档，进行解析，形成便于前端开发人员参考的文字形式的接口文档，提高了形成文字形式接口文档时的效率，节省了一定的人力资源，也便于对文字形式的接口文档更新。

可选的，图2为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图，表格实体包括：封装后的多个对象。

如图2所示，上述S102中，将解析得到的接口表，封装成表格实体，可以包括：

S201、接口表封装为一个对象。

在本发明实施例中，接口表的数量可以为多个，每个接口的描述信息可以形成一个接口表，服务器可以对每个接口表封装。例如，具有N个接口表时，对每个接口表进行封装后，也可以得到N个对象。

S202、根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象。

在一些实施方式中，对于每个接口表可以包括多个表头信息、以及每个表头信息对应的参数，服务器可以根据预设的参数划分规则，对多个表头信息，和以及每个表头信息对应的参数，进行封装，得到多个封装后的对象。

可选的，预设的参数划分规则为请求参数和响应参数的划分规则，上述S202中，根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象，可以包括：将接口表中的请求参数和响应参数，分别封装为一个对象。

在一种可能的实施方式中，接口表中可以包括多个请求参数，多个响应参数，每个请求参数可以具有对应的参数值，每个响应参数表头可以具有对应的参数值。服务器将多个请求参数封装为一个对象，将多个请求参数对应的参数值封装为一个对象；同理，将多个响应参数封装为一个对象，将多个响应参数对应的参数值封装为一个对象。

如表1所示，请求参数的多个类型可以包括：请求参数、参数名、数据类型、是否必填等，其中，请求参数和参数名对应的参数值均可以为mobile、appid，数据类型对应的参数值可以为string，参数类型对应的参数值可以为query，是否必填对应的参数值可以为Y。则服务器可以将请求参数、参数名、数据类型、是否必填等封装为一个对象，将mobile、appid、mobile、string、query和Y可以封装为一个对象。

如表1所示，响应参数的多个类型可以包括：返回参数和参数名。返回参数对应的参数值可以为：受影响行数、结果说明信息、是否成功、返回对象、错误代码，参数名对应的参数值可以为：counts、msg、success、data、errcode。则服务器可以将返回参数和参数名封装为一个对象，将受影响行数、结果说明信息、是否成功、返回对象、错误代码、counts、msg、success、data、errcode封装为一个对象，当然，也可以将受影响行数、counts封装为一个对象，将结果说明信息、msg封装为一个对象，将是否成功、success封装为一个对象，将返回对象、data封装为一个对象，将错误代码errcode封装为一个对象，本发明实施例对此不进行具体限制。

另外，请求参数和返回参数可以具有对应的说明项，以此项中对请求参数和返回参数进行说明。

表1

可选的，图3为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图，如图3所示，上述S103中根据表格实体，得到文字形式的接口文档，可以包括：

S301、根据表格实体，形成超文本标记语言HTML页面形式的接口文档。

其中，服务器中可以预设有与HTML页面形式相同的表格模板。

在一种可能的实施方式中，服务器可以采用该预设表格模板，绘制与HTML页面形式相同的表格，并将表格实体填充至该与HTML页面形式相同的表格中，形成HTML页面形式的接口文档。

需要说明的是，接口文档可以为HTML页面形式的接口文档，也可以为HTML5页面形式的接口文档，还可以为其他页面形式的接口文档，本发明实施例对此不进行具体限制。

S302、将HTML页面形式的接口文档，转换成文字形式的接口文档。

在本发明实施例中，服务器可以将HTML页面形式的接口文档，或者HTML5页面形式的接口文档中的内容进行复制，从而转换为文字形式的接口文档，该文字形式的接口文档具有对应的地址信息。

在一些实时方式中，前端研发人员需要在终端的应用程序页面上查看接口文档时，可以输入地址信息，终端可以向服务器发送该地址信息，服务器可以接收该地址信息，并根据该地址信息确定对应的文字形式的接口文档，向终端发送该文字形式的接口文档，终端可以接收该文字形式的接口文档，并向前端研发人员展示该文字形式的接口文档。

可选的，图4为本发明提供的一种网页应用系统中接口文档的生成方法的流程示意图，如图4所示，上述S301中根据表格实体，形成超文本标记语言HTML页面形式的接口文档，可以包括：

S401、根据预设的文字形式文档的表格模板，生成空白HTML页面。

其中，空白HTML页面可以包括：与表格模板相同的列表集合。

在一些实施方式中，服务器中可以预设有文字形式文档的表格模板，服务器可以根据该文字形式文档的表格模板，形成于表格模板相同的列表集合，从而生成具有集合列表的空白HTML页面。

当然，服务器也可以根据预设的文字形式文档的表格模板，生成空白HTML5页面，本发明实施例对此不进行具体限制。

S402、采用表格实体中的参数，对列表集合进行遍历，以将表格实体中的参数写入列表集合中对应位置，得到HTML页面形式的接口文档。

在一种可能的实施方式中，形成的接口文档可以为如表2所示。

表2

可选的，上述S103中根据表格实体，得到文字形式的接口文档，可以包括：根据表格实体，调用预设的文字形式的文档生成接口，生成文字形式的接口文档。

在本发明实施例中，服务器可以通过调用预设的文字形式的文档生成接口，根据表格实体中每个接口的描述信息，生成便于存储的文字形式的接口文档。

需要说明的是，根据上述方式生成文字形式的接口文档，可以为文件的形式，例如，可以为Microsoft Office Word(文档)，当然，也可以为其他形式的文档，本发明实施例对此不进行具体限制。

可选的，在上述根据表格实体，调用预设的文字形式的文档生成接口，生成文字形式的接口文档之前，该方法还可以包括：生成文档生成接口。

在一些实施方式中，服务器可以通过调用文档应用程序的文档生成接口，从而可以形成文档生成接口。其中，文档应用程序可以为Microsoft Office Word(文档)，对应的文档生成接口可以为COM接口。

当然，服务器还可以采用其他方式生成文档生成接口，以通过该接口将表格实体，转换为文字形式的接口文档。

下述对用以执行的本申请所提供的网页应用系统中接口文档的生成方法的装置、服务器及存储介质等进行说明，其具体的实现过程以及技术效果参见上述，下述不再赘述。

图5为本发明提供的一种服务器的结构示意图，如图5所示，该装置可包括：

第一获取模块501，用于获取脚本对象符号形式的接口文档；

解析模块502，用于对脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；

第二获取模块503，用于根据表格实体，得到文字形式的接口文档。

可选的，表格实体包括：封装后的多个对象；解析模块，具体用于将接口表封装为一个对象；根据预设的参数划分规则，将接口表中的参数，分别封装为一个对象。

可选的，预设的参数划分规则为请求参数和响应参数的划分规则；解析模块，还具体用于将接口表中的请求参数和响应参数，分别封装为一个对象。

可选的，第二获取模块，具体用于根据表格实体，形成超文本标记语言HTML页面形式的接口文档；将HTML页面形式的接口文档，转换成文字形式的接口文档。

可选的，第二获取模块，还具体用于根据预设的文字形式文档的表格模板，生成空白HTML页面，空白HTML页面包括：与表格模板相同的列表集合；采用表格实体中的参数，对列表集合进行遍历，以将表格实体中的参数写入列表集合中对应位置，得到HTML页面形式的接口文档。

可选的，根据二获取模块，还具体用于根据表格实体，调用预设的文字形式的文档生成接口，生成文字形式的接口文档。

可选的，装置还包括：

生成模块，用于生成文档生成接口。

上述装置用于执行前述实施例提供的方法，其实现原理和技术效果类似，在此不再赘述。

以上这些模块可以是被配置成实施以上方法的一个或多个集成电路，例如：一个或多个特定集成电路(Application Specific Integrated Circuit，简称ASIC)，或，一个或多个微处理器(digital singnal processor，简称DSP)，或，一个或者多个现场可编程门阵列(Field Programmable Gate Array，简称FPGA)等。再如，当以上某个模块通过处理元件调度程序代码的形式实现时，该处理元件可以是通用处理器，例如中央处理器(CentralProcessing Unit，简称CPU)或其它可以调用程序代码的处理器。再如，这些模块可以集成在一起，以片上系统(system-on-a-chip，简称SOC)的形式实现。

图6为本申请实施例提供的一种服务器的结构示意图，如图6所示，该服务器可以包括：存储器601、处理器602。存储器601和处理器602通过总线连接。

存储器601用于存储程序，处理器602调用存储器601存储的程序，以执行上述方法实施例。具体实现方式和技术效果类似，这里不再赘述。

可选地，本发明还提供一种程序产品，例如计算机可读存储介质，包括程序，该程序在被处理器执行时用于执行上述方法实施例。

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

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

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

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

上仅为本申请的具体实施方式，但本申请的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本申请揭露的技术范围内，可轻易想到变化或替换，都应涵盖在本申请的保护范围之内。因此，本申请的保护范围应以权利要求的保护范围为准。

Claims (10)

1.一种网页应用系统中接口文档的生成方法，其特征在于，包括：

获取脚本对象符号形式的接口文档；

对所述脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；

根据所述表格实体，得到文字形式的接口文档。

2.根据权利要求1所述的方法，其特征在于，所述表格实体包括：封装后的多个对象；所述将解析得到的接口表，封装成表格实体，包括：

将所述接口表封装为一个对象；

根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象。

3.根据权利要求2所述的方法，其特征在于，所述预设的参数划分规则为请求参数和响应参数的划分规则；所述根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象，包括：

将所述接口表中的请求参数和响应参数，分别封装为一个对象。

4.根据权利要求1-3中任一所述的方法，其特征在于，所述根据所述表格实体，得到文字形式的接口文档，包括：

根据所述表格实体，形成超文本标记语言HTML页面形式的接口文档；

将所述HTML页面形式的接口文档，转换成所述文字形式的接口文档。

5.根据权利要求4所述的方法，其特征在于，所述根据所述表格实体，形成超文本标记语言HTML页面形式的接口文档，包括：

根据预设的文字形式文档的表格模板，生成空白HTML页面，所述空白HTML页面包括：与所述表格模板相同的列表集合；

采用所述表格实体中的参数，对所述列表集合进行遍历，以将所述表格实体中的参数写入所述列表集合中对应位置，得到所述HTML页面形式的接口文档。

6.根据权利要求1-3中任一所述的方法，其特征在于，所述根据所述表格实体，得到文字形式的接口文档，包括：

根据所述表格实体，调用预设的文字形式的文档生成接口，生成所述文字形式的接口文档。

7.根据权利要求6所述的方法，其特征在于，所述根据所述表格实体，调用预设的文字形式的文档生成接口，生成所述文字形式的接口文档之前，所述方法还包括：

生成所述文档生成接口。

8.一种网页应用系统中接口文档的生成装置，其特征在于，包括：

第一获取模块，用于获取脚本对象符号形式的接口文档；

解析模块，用于对所述脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；

第二获取模块，用于根据所述表格实体，得到文字形式的接口文档。

9.一种服务器，其特征在于，包括：存储器和处理器，所述存储器存储有所述处理器可执行的计算机程序，所述处理器执行所述计算机程序时实现上述权利要求1-7任一项所述的方法。

10.一种存储介质，其特征在于，所述存储介质上存储有计算机程序，所述计算机程序被读取并执行时，实现上述权利要求1-7任一项所述的方法。

Images