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

说明书

本申请实施例公开了一种接口文档的生成方法、装置、存储介质及电子设备。该方法包括：通过JavaDoc插件读取目标接口的源码数据，并根据所述源码数据，确定目标接口的文档参数；基于所述文档参数生成Maven插件，以在工程中执行命令时使用所述Maven插件生成目标接口文档。通过运行本申请所提供的技术方案，可以实现自动生成接口文档，以降低接口文档的管理维护成本的目的。

技术领域

本申请实施例涉及计算机技术领域，尤其涉及一种接口文档的生成方法、装置、存储介质及电子设备。

背景技术

随着科技水平的迅速发展，各种平台不断的在推出新的软件以及对已有软件进行更新，以满足用户的需求。

软件开发过程中，接口提供方和接口使用方之间需要维护接口文档，但维护此接口文档会有投入人力和不能实时更新等很多问题。其中，接口提供方需要在接口变动的时，手动更新接口文档，如果未及时更新，就会重新调用错误；接口提供方在源码级别已经写好文档，又要在一个接口公共平台重新编写，效率低下。

发明内容

本申请实施例提供一种接口文档的生成方法、装置、存储介质及电子设备，以实现自动生成接口文档，以降低接口文档的管理维护成本的目的。

第一方面，本申请实施例提供了一种接口文档的生成方法，该方法包括：

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

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

可选的，所述目标接口的文档参数包括：请求方式、请求路径、入参和返回值。

可选的，根据所述源码数据，确定目标接口的文档参数，包括：

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

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

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

可选的，若所述目标接口为REST接口，则所述目标接口的Java类为Controller；

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

可选的，按照与所述Java类相匹配的预设策略获取目标接口的文档参数，包括：

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

可选的，通过JavaDoc插件读取目标接口的源码数据，包括：

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

第二方面，本申请实施例提供了一种接口文档的生成装置，该装置包括：

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

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

可选的，所述目标接口的文档参数包括：请求方式、请求路径、入参和返回值。

第三方面，本申请实施例提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器运行时实现如本申请实施例所述的接口文档的生成方法。