[发明专利]一种预设API文档生成方法、装置、设备和存储介质

权利要求书

1.一种预设API文档生成方法，其特征在于，包括：

接收生成预设API文档的指令，获取所述预设API文档的文件格式；其中，所述预设API文档包括API文档和/或API调试文档；

获取待测试接口的接口测试文件；

获取文档头部；其中，所述文档头部包括目录信息；

运行所述接口测试文件，生成所述待测试接口对应的所述预设API文档片段；

根据所述文档头部和所述待测试接口对应的所述预设API文档片段，基于所述文件格式，生成所述预设API文档。

2.根据权利要求1所述的预设API文档生成方法，其特征在于，所述接口测试文件具有对应的模块名；以及

在所述运行所述接口测试文件之前，还包括：

获取所述接口测试文件对应的所述模块名；

将所述模块名设置于所述文档头部之后，作为所述待测试接口对应的所述预设API文档片段的模块标题和一级目录。

3.根据权利要求1所述的预设API文档生成方法，其特征在于，所述运行所述接口测试文件，包括：

通过源代码扫描，从所述接口测试文件中获取接口名、接口参数说明和接口返回值说明；

通过模拟接口请求，从所述接口测试文件中获取接口请求地址、接口请求头示例、接口参数示例和接口返回值示例；

所述生成所述待测试接口对应的所述预设API文档片段，包括：

根据所述接口名、所述接口参数说明、所述接口返回值说明、所述接口请求地址、所述接口参数示例和所述接口返回值示例生成API文档片段；和/或

根据所述接口名、所述接口请求地址、所述接口参数示例和所述接口请求头示例生成API调试文档片段。

4.根据权利要求3所述的预设API文档生成方法，其特征在于，所述源代码扫描，包括：

若编程语言及框架支持读取接口源代码，则直接读取所述待测试接口的源代码；

若编程语言及框架不支持读取接口源代码，则通过测试代码配置接口的所在文件名及方法名，在接口测试时根据所述文件名和所述方法名读取所述待测试接口的源代码。

5.根据权利要求1所述的预设API文档生成方法，其特征在于，所述预设API文档的文件格式，包括：

所述API文档的文件格式为Textile；

所述API调试文档的文件格式为Json。

6.根据权利要求1所述的预设API文档生成方法，其特征在于，所述目录信息，包括：

文档的全局说明、生成时间、作者和目录表达式。

7.一种预设API文档生成装置，其特征在于，包括：

指令接收模块，用于接收生成预设API文档的指令，获取所述预设API文档的文件格式；其中，所述预设API文档包括API文档和/或API调试文档；

接口测试文件获取模块，用于获取待测试接口的接口测试文件；

文档头部获取模块，用于获取文档头部；其中，所述文档头部包括目录信息；

接口测试文件运行模块，用于运行所述接口测试文件，生成所述待测试接口对应的所述预设API文档片段；

预设API文档生成模块，用于根据所述文档头部和所述待测试接口对应的所述预设API文档片段，基于所述文件格式，生成所述预设API文档。

8.根据权利要求7所述的预设API文档生成装置，其特征在于，所述接口测试文件具有对应的模块名；

所述预设API文档生成装置还包括：

模块名获取模块，用于在所述运行所述接口测试文件之前，获取所述接口测试文件对应的所述模块名；

模块名设置模块，用于将所述模块名设置于所述文档头部之后，作为所述待测试接口对应的所述预设API文档片段的模块标题和一级目录。