[发明专利]一种接口文档的生成方法、装置、存储介质及电子设备

权利要求书

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

通过JavaDoc插件读取目标接口的源码数据，并根据所述源码数据，确定目标接口的文档参数；

基于所述文档参数生成Maven插件，以在工程中执行命令时使用所述Maven插件生成目标接口文档。

2.根据权利要求1所述的方法，其特征在于，所述目标接口的文档参数包括：请求方式、请求路径、入参和返回值。

3.根据权利要求1所述的方法，其特征在于，根据所述源码数据，确定目标接口的文档参数，包括：

根据所述源码数据，确定目标接口类别；

根据所述目标接口类别，确定与目标接口类别对应的Java类；

按照与所述Java类相匹配的预设策略获取目标接口的文档参数。

4.根据权利要求3所述的方法，其特征在于，若所述目标接口为REST接口，则所述目标接口的Java类为Controller；

若所述目标接口为RPC接口，则所述目标接口的Java类为Interface。

5.根据权利要求3所述的方法，其特征在于，按照与所述Java类相匹配的预设策略获取目标接口的文档参数，包括：

按照与所述Java类相匹配的预设策略获，依次获取目标接口请求路径、请求方式、入参类型和返回值类型，以得到目标接口的文档参数。

6.根据权利要求2所述的方法，其特征在于，通过JavaDoc插件读取目标接口的源码数据，包括：

通过JavaDoc插件提供的Doclet接口对目标接口的源码数据进行读取。

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

文档参数确定模块，用于通过JavaDoc插件读取目标接口的源码数据，并根据所述源码数据，确定目标接口的文档参数；

接口文档生成模块，用于基于所述文档参数生成Maven插件，以在工程中执行命令时使用所述Maven插件生成目标接口文档。

8.根据权利要求7所述的装置，其特征在于，所述目标接口的文档参数包括：请求方式、请求路径、入参和返回值。

9.一种计算机可读存储介质，其上存储有计算机程序，其特征在于，该程序被处理器执行时实现如权利要求1-6中任一项所述的接口文档的生成方法。

10.一种电子设备，包括存储器，处理器及存储在存储器上并可在处理器运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如权利要求1-6中任一项所述的接口文档的生成方法。