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

说明书

本发明实施例公开了一种预设API文档生成方法、装置、设备及存储介质。其方法包括：接收生成预设API文档的指令，获取所述预设API文档的文件格式；其中，所述预设API文档包括API文档和/或API调试文档；获取待测试接口的接口测试文件；获取文档头部；其中，所述文档头部包括目录信息；运行所述接口测试文件，生成所述待测试接口对应的所述预设API文档片段；根据所述文档头部和所述待测试接口对应的所述预设API文档片段，基于所述文件格式，生成所述预设API文档。本发明实施例在进行自动化接口测试的同时，便可生成API文档和API调试文档，减少了大量的人工编码与注释，且不易出错。

技术领域

本发明实施例涉及软件开发与软件测试领域，尤其涉及一种预设API文档生成方法、装置、设备和存储介质。

背景技术

随着移动应用的普及，后台开发人员承担了更多的接口开发任务，在做接口开发时免不了要编写API文档与录入数据进API调试工具。

目前流行两种自动化生成API文档的方案，方案一是利用注解生成API文档，典型案例为swagger，其缺点是需要编写冗长的API描述文档；方案二是利用注释生成API文档，典型案例为apidoc，其缺点是开发人员需维护大量的注释代码，这与手写文档无本质区别。上述两种方案的共同缺点是参数示例与返回值示例都需人工编码。目前流行两种录入数据进API调试工具的方案，方案一是人工录入，其缺点是需要大量的人工操作；方案二是导入swagger格式的API描述文档到API调试工具，但需要开发人员进行繁琐编码。

综上所述，通过现有技术自动生成API文档时，仍然需要大量的人工编码与注释，而且API文档无法自动生成，仍然要靠人工录入或编码，这将给开发人员带来大量工作量，进一步地，大量人员操作也将不可避免的出现错误，导致文档与代码脱节，使得文档与代码所述不符，影响开发工作的顺利进行。

发明内容

本发明实施例提供一种预设API文档生成方法、装置、设备及存储介质，以实现减少人工操作，减少出错的技术效果。

第一方面，本发明实施例提供了一种预设API文档生成方法，包括：

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

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

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

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

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

第二方面，本发明实施例提供了一种预设API文档生成装置，包括：

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

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

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

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

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

第三方面，本发明实施例提供了一种设备，包括：

一个或多个处理器；

存储装置，用于存储一个或多个程序，