[发明专利]生成应用程序编程接口文档的方法、装置及电子设备

说明书

公开了一种生成应用程序编程接口文档的方法及装置，其中方法包括：确定源代码文件，所述源代码文件为应用程序的源代码；基于所述源代码文件，确定与所述应用程序的编程接口相关的接口信息；基于与所述应用程序的编程接口相关的接口信息，生成与所述应用程序对应的接口文档，其中，所述接口文档中包含：所述源代码文件中的与所述应用程序的源代码相关的各个公共逻辑模块的调用接口信息，以及各个所述公共逻辑模板的调用接口之间的关联信息。本公开提供的技术方案可以提高接口文档的应用效率，进一步提高开发效率。

技术领域

本发明涉及计算机技术领域，具体涉及一种生成应用程序编程接口文档的方法、装置及电子设备。

背景技术

日常web(World Wide Web，万维网)应用开发中，在使用web开发代码(例如：TypeScript代码、java代码、python代码等)开发过程中常常需要引用很多公共逻辑模块(例如，函数、组件等)，对于未参加开发这些公共逻辑模块的开发人员而言，需要查看源代码才能了解到这些公共逻辑模块对外的调用接口是怎么样的，这种需要开发人员查看源代码的方式需要花费开发人员很多时间，尤其是对于将这些公共逻辑模块当作公共平台资源提供时，会需要花费开发人员更多的时间去查看源代码，从而降低了开发效率。

发明内容

为了解决上述技术问题，本申请实施例提供了一种生成应用程序编程接口文档的方法、装置及电子设备。

根据本申请的一个方面，提供了一种生成应用程序编程接口文档的方法，包括：确定源代码文件，所述源代码文件为应用程序的源代码；基于所述源代码文件，确定与所述应用程序的编程接口相关的接口信息；基于与所述应用程序的编程接口相关的接口信息，生成与所述应用程序对应的接口文档，其中，所述接口文档中包含：所述源代码文件中的与所述应用程序的源代码相关的各个公共逻辑模块的调用接口信息，以及各个所述公共逻辑模板的调用接口之间的关联信息。

根据本申请的另一个方面，提供了一种生成应用程序编程接口文档的装置，包括：源代码确定模块，用于确定源代码文件，所述源代码文件为应用程序的源代码；节点信息确定模块，用于基于所述源代码文件，确定与所述应用程序的编程接口相关的接口信息；接口文档确定模块，用于基于与所述应用程序的编程接口相关的接口信息，生成与所述应用程序对应的接口文档，其中，所述接口文档中包含：所述源代码文件中的与所述应用程序的源代码相关的各个公共逻辑模块的调用接口信息，以及各个所述公共逻辑模板的调用接口之间的关联信息。

根据本申请的另一个方面，提供了一种计算机可读存储介质，所述存储介质存储有计算机程序，所述计算机程序用于执行上述任一所述的方法。

根据本申请的另一个方面，提供了一种电子设备，所述电子设备包括：处理器；用于存储所述处理器可执行指令的存储器；所述处理器，用于执行上述任一所述的方法。

本申请实施例提供的生成应用程序编程接口文档的方法，确定源代码文件，基于源代码文件，确定与应用程序的编程接口相关的接口信息，基于与应用程序的编程接口相关的接口信息，生成与应用程序对应的接口文档，其中，由于接口文档中不仅包含源代码文件中的与应用程序的源代码相关的各个公共逻辑模块的调用接口信息，还包含各个公共逻辑模板的调用接口之间的关联信息，因此可以确保生成的接口文档中的信息量比较丰富，进而不需要开发人员花费时间去查看源代码就可以开发使用，大大提高了接口文档的应用效率，进一步提高了开发人员的开发效率。

附图说明

通过结合附图对本申请实施例进行更详细的描述，本申请的上述以及其他目的、特征和优势将变得更加明显。附图用来提供对本申请实施例的进一步理解，并且构成说明书的一部分，与本申请实施例一起用于解释本申请，并不构成对本申请的限制。在附图中，相同的参考标号通常代表相同部件或步骤。

图1是本申请一示例性实施例提供的一种生成应用程序编程接口文档的方法的流程示意图。