CN109408375A - 接口文档的生成方法和装置 - Google Patents

Abstract

本申请提供了一种接口文档的生成方法和装置，该方法包括：获取目标项目的测试脚本，该测试脚本用于测试该目标项目中的目标接口；对该目标项目的测试脚本进行解析，得到该目标接口的接口信息，该接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；将该目标接口的接口信息存储在内存中的对象列表中；将该对象列表中的该目标接口的接口信息填充到预定义的接口文档模板中，以生成该目标接口的接口文档。采用本申请的接口文档的生成方法，能够根据接口的测试脚本自动生成接口文档，从而提高工作效率。

Description

接口文档的生成方法和装置

技术领域

本申请涉及测试技术领域，并且更具体地，涉及测试技术领域中接口文档的生成方法和装置。

背景技术

接口，即应用程序编程接口(application programming interface，API)。通常由开发人员完成软件开发，并由测试人员通过接口测试脚本对接口进行测试。

为响应快速变化，开发人员和测试人员之间大多采用重沟通、轻文档的敏捷模式。由于对敏捷的理解不尽相同，甚至有的公司没有接口文档。测试人员和开发人员靠不断的沟通和确认才能完成接口测试工作。有的公司虽然有接口文档，但接口变动后文档经常不更新，以至于实际提测的接口和接口文档的定义不一致，最后还是需要测试人员和开发人员反复的沟通和确认，由于需要耗费大量的沟通成本，因此，工作效率较低。

此外，现有技术中，Swagger是一款根据软件开发人员在代码中的标注注解生成接口文档的工具，开发过程中也需要耗费大量的人力资源，因此，工作效率较低。

发明内容

本申请提供一种接口文档的生成方法和装置，能够根据接口的测试脚本自动生成接口文档，从而提高工作效率。

为实现上述目的，本申请提供一种接口文档的生成方法，包括以下内容：

获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；

对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；

将所述目标接口的接口信息存储在内存中的对象列表中；

将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

可选地，所述目标接口包括至少一个接口，所述目标项目的测试脚本包括所述至少一个接口中每个接口的测试脚本，所述对象列表包括至少一个对象，所述至少一个对象与所述至少一个接口的接口信息一一对应。

可选地，在所述将所述目标接口的接口信息存储在内存中的对象列表中之后，所述方法还包括：将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下，所述数据库中的所述目标项目下包括至少一个记录，所述至少一个记录与所述至少一个对象一一对应。

可选地，在所述将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下之后，所述方法还包括：获取脚本请求，所述脚本请求携带所述目标项目的标识；根据所述目标项目的标识，获取所述数据库中所述目标项目下存储的所述至少一个记录；将所述至少一个记录加载到所述内存中，得到所述对象列表，所述对象列表中包括所述至少一个接口中每个接口的接口信息；将所述每个接口的接口信息填充到所述预定义的接口文档模板中，以生成所述每个接口的接口文档。

可选地，在所述对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息之前，所述方法还包括：根据所述目标项目的测试脚本采用的数据协议和/或数据存储格式，确定所述目标项目的测试脚本的解析方法；所述对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，包括：通过所述解析方法对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息。

可选地，所述获取目标项目的测试脚本，包括：从Postman或Jmeter获取所述目标项目的测试脚本。

可选地，在所述将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档之后，所述方法还包括：通过HTML格式或PDF格式输出所述目标接口的接口文档。

为实现上述目的，本申请还提供一种接口文档的生成装置，该装置具体包括：

获取单元，用于获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；

解析单元，用于对所述获取单元获取的所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；

存储单元，用于将所述解析单元解析的所述目标接口的接口信息存储在内存中的对象列表中；

生成单元，用于将所述存储单元存储的所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

可选地，所述目标接口包括至少一个接口，所述目标项目的测试脚本包括所述至少一个接口中每个接口的测试脚本，所述对象列表包括至少一个对象，所述至少一个对象与所述至少一个接口的接口信息一一对应。

可选地，所述存储单元还用于：将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下，所述数据库中的所述目标项目下包括至少一个记录，所述至少一个记录与所述至少一个对象一一对应。

可选地，所述装置还包括加载单元，所述获取单元还用于取脚本请求，所述脚本请求携带所述目标项目的标识；根据所述目标项目的标识，获取所述数据库中所述目标项目下存储的所述至少一个记录；所述加载单元用于将所述至少一个记录加载到所述内存中，得到所述对象列表，所述对象列表中包括所述至少一个接口中每个接口的接口信息；所述填充单元还用于将所述每个接口的接口信息填充到所述预定义的接口文档模板中，以生成所述每个接口的接口文档。

可选地，所述装置还包括确定单元，所述确定单元用于根据所述目标项目的测试脚本采用的数据协议和/或数据存储格式，确定所述目标项目的测试脚本的解析方法；所述解析单元具体用于通过所述解析方法对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息。

可选地，所述获取单元具体用于从Postman或Jmeter获取所述目标项目的测试脚本。

可选地，所述装置还包括输出单元，所述输出单元用于通过HTML格式或PDF格式输出所述目标接口的接口文档。

为实现上述目的，本申请还提供一种计算机设备，包括存储器、处理器、通信接口以及存储在所述存储器上并可在所述处理器上运行的计算机程序，其中，所述存储器、所述处理器以及所述通信接口之间通过内部连接通路互相通信，所述处理器执行所述计算机程序时实现如下步骤：

获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；

对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；

将所述目标接口的接口信息存储在内存中的对象列表中；

将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

为实现上述目的，本申请还提供计算机可读存储介质，其上存储有计算机程序，所述计算机程序被处理器执行时实现如下步骤：

获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；

对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；

将所述目标接口的接口信息存储在内存中的对象列表中；

将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

本申请提供的接口文档的生成方法、装置、计算机设备和计算机可读存储介质，获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；将所述目标接口的接口信息存储在内存中的对象列表中；将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。采用本申请的接口文档的生成方法、装置、计算机设备和计算机可读存储介质，能够根据接口的测试脚本自动生成接口文档，从而提高工作效率。

附图说明

图1是本申请实施例提供的接口文档的生成方法的示意性流程图；

图2是本申请实施例提供的另一接口文档的生成方法的示意性流程图；

图3是本申请实施例提供的接口文档的生成装置的示意性框图；

图4是本申请实施例提供的接口文档的生成装置的示意性框图。

具体实施方式

为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本申请进行进一步详细说明。应当理解，此处所描述的具体实施例仅用以解释本申请，并不用于限定本申请。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。

图1示出了本申请实施例提供的接口文档的生成方法100的示意性流程图。应理解，该方法100可以由接口文档的生成装置执行，以下简称装置。

S110，获取目标项目的测试脚本，该测试脚本用于测试该目标项目中的目标接口。

可选地，该装置可以通过多种方式获取该目标项目的测试脚本，本申请实施例对此不作限定。

在一种可能的实现方式中，该装置可以从Postman或Jmeter等脚本生成装置获取该目标项目的测试脚本。

在另一种可能的实现方式中，该装置可以获取该目标项目的测试脚本的URL，根据该URL获取该目标项目的测试脚本。

S120，对该目标项目的测试脚本进行解析，得到该目标接口的接口信息，该接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息。

具体地，该装置可以按照与该测试脚本的数据存储对象的格式对应的解析方法，对该目标项目的测试脚本进行解析，得到该目标接口的接口信息。

可选地，数据存储对象可以理解为一个类，该类包括自定义的多个字段，该多个字段与接口信息中包括的多项信息一一对应。

例如，类中可以包括接口名称字段、接口地址字段、资源路径字段、请求方式字段、头信息字段、内容类型字段、请求参数的定义(字段名、类型、约束)字段和响应报文的定义(字段名、类型、约束)字段等。

应理解，该测试脚本的数据存储对象的格式可以理解为该数据存储对象中每个字段所在的位置。

还应理解，该测试脚本的数据存储格式对应的解析方法可以理解为接口文档中的接口信息与接口信息在测试脚本中相应字段的位置的映射关系。

可选地，该装置可以预先配置测试脚本中每种接口信息与该每种接口信息所在字段的位置之间的映射关系。

在一种可能的实现方式中，若测试脚本是人工编写并上传的，该测试脚本的数据存储对象的格式是预定义的。因此，该装置可以根据与该数据存储对象的格式对应的解析方法，对该目标项目的测试脚本进行解析，得到该接口文档中所包含的接口信息。

例如，若以该测试脚本中包括接口名称字段和接口地址字段。其中，位置1：接口名称字段；位置2：接口地址字段。则该装置可以根据该映射关系，从该测试脚本中每个接口信息的字段获取到接口信息。

在另一种可能的实现方式中，若测试脚本是从Postman获取的，支持json格式；因此，该装置根据与该Postman工具中定义的数据存储对象的格式对应的解析方法，对该目标项目的测试脚本进行解析，得到该接口文档中所包含的接口信息。过程与人工编写的类似，为避免重复，此处不再赘述。

可选地，该接口信息可以包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中一项或多项信息，本申请实施例对此不作限定。

在一种可能的实现方式中，该接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义(字段名、类型、约束)、响应报文的定义(字段名、类型、约束)。

S130，将该目标接口的接口信息存储在内存中的对象列表中。

可选地，该目标接口可以包括一个或多个接口，本申请实施例对此不作限定。

在一种可能的实现方式中，该目标接口包括至少一个接口，该目标项目的测试脚本包括该至少一个接口中每个接口的测试脚本，该对象列表包括至少一个对象，该至少一个对象与该至少一个接口的接口信息一一对应。

例如，内存中的对象列表可以包括如下内容：

对象1—接口1的接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义(字段名、类型、约束)、响应报文的定义(字段名、类型、约束)；

对象2—接口2的接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义(字段名、类型、约束)、响应报文的定义(字段名、类型、约束)；

………

应理解，方法100适用于数据库中从未建立目标项目的目录，且该目标项目的目录下未存储与该目标项目中每个接口的接口信息对应的记录。即该方法100适用于首次在数据库建立该目标项目。

可选地，在S130之后，该方法还包括：将该对象列表中的该至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的该目标项目下，该数据库中的该目标项目下包括至少一个记录，该至少一个记录与该至少一个对象一一对应。

例如，数据库中的目标项目111可以存储如下内容：

目标项目111：

记录1—对象1；

记录2—对象2；

………

可选地，在S130之后，该方法还包括：获取脚本请求，该脚本请求用于获取目标项目的测试脚本，该脚本请求携带该目标项目的标识；根据该目标项目的标识，获取该数据库中该目标项目下存储的该至少一个记录；将该至少一个记录加载到该内存中，得到该对象列表，该对象列表中包括该至少一个接口中每个接口的接口信息；将该每个接口的接口信息填充到该预定义的接口文档模板中，以生成该每个接口的接口文档。

也就是说，该装置可以在数据库中建立该目标项目的目录，为该目标项目设置标识，并将该内存中存储的对象列表存储至数据库中该目标项目的目录下，使得后续再次需要生成该目标接口的接口文档时，可以直接从数据库中该目标项目的目录下调用对象列表，无需重新对该目标项目的测试脚本进行解析，提高了接口文档的生成效率。

S140，将该对象列表中的该目标接口的接口信息填充到预定义的接口文档模板中，以生成该目标接口的接口文档。

应理解，本申请实施例中该的预定义的接口文档，可以理解为按照规范化、标准化的框架编写的接口文档中包括的各项信息，使得无论是针对哪个接口，输出的接口文档的格式保持一致。

可选地，在S140之后，该方法还包括：通过HTML格式或PDF格式输出该目标接口的接口文档。

本申请提供的接口文档的生成方法，通过获取目标项目的测试脚本，该测试脚本用于测试该目标项目中的目标接口；对该目标项目的测试脚本进行解析，得到该目标接口的接口信息，该接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；将该目标接口的接口信息存储在内存中的对象列表中；将该对象列表中的该目标接口的接口信息填充到预定义的接口文档模板中，以生成该目标接口的接口文档。采用本申请的接口文档的生成方法，能够根据接口的测试脚本自动生成接口文档，从而提高工作效率。

图2示出了本申请实施例提供的接口文档的生成方法200的示意性流程图。应理解，该方法200可以由上述装置执行。

应理解，方法200适用于数据库中已经建立目标项目的目录，且该目标项目的目录下存储有与该目标项目中每个接口的接口信息对应的记录。即该方法200适用于非首次在数据库建立该目标项目。

也就是说，在S210之前，该数据库中的所述目标项目的目录下存储有该目标项目的至少一个记录，所述至少一个记录与所述目标项目包括的至少一个接口的接口信息一一对应。

可选地，该至少一个接口中每个接口的接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息。

可选地，该至少一个记录中每个记录是按照预先定义的数据存储对象存储的。

可选地，数据库中数据存储对象可以理解为一个类，所述类包括自定义的多个字段，该多个字段与接口信息中包括的多项信息一一对应。

S210，获取脚本请求，所述脚本请求用于获取目标项目的测试脚本，所述脚本请求携带目标项目的标识。

可选地，数据库中可以建立至少一个项目的目录，该至少一个项目中每个项目的目录下存储有该项目对应的至少一个记录，其中，该至少一个项目包括该目标项目。相应地，该装置可以根据该脚本请求中携带的目标项目的标识，找到数据库中存储的该目标项目的目录。

S220，根据所述目标项目的标识，获取数据库中所述目标项目下存储的至少一个记录。

S230，将所述至少一个记录加载到所述内存中，得到所述对象列表。

可选地，该对象列表包括至少一个对象，该至少一个对象与所述至少一个接口一一对。

S240，将该每个接口的接口信息填充到该预定义的接口文档模板中，以生成该每个接口的接口文档。

应理解，本申请实施例中该的预定义的接口文档，可以理解为按照规范化、标准化的框架编写的接口文档中包括的各项信息，使得无论是针对哪个接口，输出的接口文档的格式保持一致。

本申请提供的接口文档的生成方法，在数据库中已建立该目标项目的目录，并在该目录下存储有该目标项目中的目标接口的接口信息对应的记录的情况下，后续再次需要生成该目标接口的接口文档时，可以直接从数据库中该目标项目的目录下调用对象列表，而无需重新对该目标项目的测试脚本进行解析，提高了接口文档的生成效率。

上面结合图1和图2介绍了本申请实施例提供的接口文档的生成方法，下面将结合图3和图4介绍本申请实施例提供的接口文档的生成装置。

图3示出了本申请实施例提供的接口文档的生成装置300的示意性框图。该装置300包括：

获取单元310，用于获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；

解析单元320，用于对所述获取单元310获取的所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；

存储单元330，用于将所述解析单元320解析的所述目标接口的接口信息存储在内存中的对象列表中；

生成单元340，用于将所述存储单元330存储的所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

可选地，所述目标接口包括至少一个接口，所述目标项目的测试脚本包括所述至少一个接口中每个接口的测试脚本，所述对象列表包括至少一个对象，所述至少一个对象与所述至少一个接口的接口信息一一对应。

可选地，在所述将所述目标接口的接口信息存储在内存中的对象列表中之后，所述方法还包括：将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下，所述数据库中的所述目标项目下包括至少一个记录，所述至少一个记录与所述至少一个对象一一对应。

可选地，在所述将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下之后，所述方法还包括：获取脚本请求，所述脚本请求携带所述目标项目的标识；根据所述目标项目的标识，获取所述数据库中所述目标项目下存储的所述至少一个记录；将所述至少一个记录加载到所述内存中，得到所述对象列表，所述对象列表中包括所述至少一个接口中每个接口的接口信息；将所述每个接口的接口信息填充到所述预定义的接口文档模板中，以生成所述每个接口的接口文档。

可选地，在所述对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息之前，所述方法还包括：根据所述目标项目的测试脚本采用的数据协议和/或数据存储格式，确定所述目标项目的测试脚本的解析方法；所述对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，包括：通过所述解析方法对所述目标项目的测试脚本进行解析，得到所述目标接口的接口文档。

可选地，所述获取目标项目的测试脚本，包括：从Postman或Jmeter获取所述目标项目的测试脚本。

可选地，在所述将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档之后，所述方法还包括：通过HTML格式或PDF格式输出所述目标接口的接口文档。

图4示出了本申请实施例提供的接口文档的生成装置400的示意性框图。该装置400可以为图4中所述的装置400，该装置400可以采用如图4所示的硬件架构。该装置400可以包括处理器410、通信接口420和存储器430，该处理器410、通信接口420和存储器430通过内部连接通路互相通信。图3中的解析单元320、存储单元330和生成单元340所实现的相关功能可以由处理器410来实现，获取单元310所实现的相关功能可以由处理器410控制通信接口420来实现。

该处理器410可以包括是一个或多个处理器，例如包括一个或多个中央处理单元(central processing unit，CPU)，在处理器是一个CPU的情况下，该CPU可以是单核CPU，也可以是多核CPU。

具体地，该处理器410用于获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；将所述目标接口的接口信息存储在内存中的对象列表中；将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

该通信接口420用于输入和/或输出数据。该通信接口可以包括发送接口和接收接口，发送接口用于输出数据，接收接口用于输入数据。

该存储器430包括但不限于是随机存取存储器(random access memory，RAM)、只读存储器(read-only memory，ROM)、可擦除可编程存储器(erasable programmable readonly memory，EPROM)、只读光盘(compact disc read-only memory，CD-ROM)，该存储器430用于存储相关指令及数据。

存储器430用于存储该装置的程序代码和数据，可以为单独的器件或集成在处理器410中。

具体地，所述处理器410用于控制通信接口420与其他组件，例如，文档编写器，进行通信。具体可参见方法实施例中的描述，在此不再赘述。

可以理解的是，图4仅仅示出了装置的简化设计。在实际应用中，图像检索装置还可以分别包含必要的其他元件，包含但不限于任意数量的通信接口、处理器、控制器、存储器等，而所有可以实现本申请的装置都在本申请的保护范围之内。

在一种可能的设计中，该装置400可以被替换为芯片装置，例如可以为可用于该装置中的芯片，用于实现该装置中处理器410的相关功能。该芯片装置可以为实现相关功能的现场可编程门阵列，专用集成芯片，系统芯片，中央处理器，网络处理器，数字信号处理电路，微控制器，还可以采用可编程控制器或其他集成芯片。该芯片中，可选的可以包括一个或多个存储器，用于存储程序代码，当所述代码被执行时，使得处理器实现相应的功能。

本领域普通技术人员可以意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、或者计算机软件和电子硬件的结合来实现。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本申请的范围。

所属领域的技术人员可以清楚地了解到，为描述的方便和简洁，上述描述的系统、装置和单元的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。

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

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

另外，在本申请各个实施例中的各功能单元可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。

所述功能如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本申请的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本申请各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、ROM、RAM、磁碟或者光盘等各种可以存储程序代码的介质。

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

Claims (10)

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

获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；

对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；

将所述目标接口的接口信息存储在内存中的对象列表中；

将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

2.根据权利要求1所述的方法，其特征在于，所述目标接口包括至少一个接口，所述目标项目的测试脚本包括所述至少一个接口中每个接口的测试脚本，所述对象列表包括至少一个对象，所述至少一个对象与所述至少一个接口的接口信息一一对应。

3.根据权利要求2所述的方法，其特征在于，在将所述目标接口的接口信息存储在内存中的对象列表中之后，所述方法还包括：

将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下，所述数据库中的所述目标项目下包括至少一个记录，所述至少一个记录与所述至少一个对象一一对应。

4.根据权利要求3所述的方法，其特征在于，在将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下之后，所述方法还包括：

获取脚本请求，所述脚本请求携带所述目标项目的标识；

根据所述目标项目的标识，获取所述数据库中所述目标项目下存储的所述至少一个记录；

将所述至少一个记录加载到所述内存中，得到所述对象列表，所述对象列表中包括所述至少一个接口中每个接口的接口信息；

将所述每个接口的接口信息填充到所述预定义的接口文档模板中，以生成所述每个接口的接口文档。

5.根据权利要求1至4中任一项所述的方法，其特征在于，在对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息之前，所述方法还包括：

根据所述目标项目的测试脚本采用的数据协议和/或数据存储格式，确定所述目标项目的测试脚本的解析方法；

所述对所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，包括：

通过所述解析方法对所述目标项目的测试脚本进行解析，得到所述目标接口的测试脚本。

6.根据权利要求1至4中任一项所述的方法，其特征在于，获取目标项目的测试脚本，包括：

从Postman或Jmeter获取所述目标项目的测试脚本。

7.根据权利要求1至4中任一项所述的方法，其特征在于，在将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档之后，所述方法还包括：

通过HTML格式或PDF格式输出所述目标接口的接口文档。

8.一种接口文档的生成装置，其特征在于，包括：

获取单元，用于获取目标项目的测试脚本，所述测试脚本用于测试所述目标项目中的目标接口；

解析单元，用于对所述获取单元获取的所述目标项目的测试脚本进行解析，得到所述目标接口的接口信息，所述接口信息包括：接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息；

存储单元，用于将所述解析单元解析的所述目标接口的接口信息存储在内存中的对象列表中；

生成单元，用于将所述存储单元存储的所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中，以生成所述目标接口的接口文档。

9.一种计算机设备，包括存储器、处理器、显示器以及存储在所述存储器上并可在所述处理器上运行的计算机程序，其中，所述存储器、所述处理器以及所述显示器之间通过内部连接通路互相通信，其特征在于，所述处理器控制所述显示器执行所述计算机程序时实现上述权利要求1至7中任一项所述的方法的步骤。

10.一种计算机可读存储介质，用于存储计算机程序，其特征在于，所述计算机程序被处理器执行时实现上述权利要求1至7中任一项所述的方法的步骤。