一种接口文档的生成方法、装置、存储介质及电子设备制造方法及图纸

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

An interface document generation method, device, storage medium and electronic equipment

【技术实现步骤摘要】
一种接口文档的生成方法、装置、存储介质及电子设备
本申请实施例涉及计算机
，尤其涉及一种接口文档的生成方法、装置、存储介质及电子设备。
技术介绍
随着科技水平的迅速发展，各种平台不断的在推出新的软件以及对已有软件进行更新，以满足用户的需求。软件开发过程中，接口提供方和接口使用方之间需要维护接口文档，但维护此接口文档会有投入人力和不能实时更新等很多问题。其中，接口提供方需要在接口变动的时，手动更新接口文档，如果未及时更新，就会重新调用错误；接口提供方在源码级别已经写好文档，又要在一个接口公共平台重新编写，效率低下。
技术实现思路
本申请实施例提供一种接口文档的生成方法、装置、存储介质及电子设备，以实现自动生成接口文档，以降低接口文档的管理维护成本的目的。第一方面，本申请实施例提供了一种接口文档的生成方法，该方法包括：通过JavaDoc插件读取目标接口的源码数据，并根据所述源码数据，确定目标接口的文档参数；基于所述文档参数生成Maven插件，以在工程中执行命令时使用所述Maven插件生成目标本文档来自技高网...

【技术保护点】
1.一种接口文档的生成方法，其特征在于，包括：/n通过JavaDoc插件读取目标接口的源码数据，并根据所述源码数据，确定目标接口的文档参数；/n基于所述文档参数生成Maven插件，以在工程中执行命令时使用所述Maven插件生成目标接口文档。/n

【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，包括：
通过JavaDoc插件读取目标接口的源码数据，并根据所述源码数据，确定目标接口的文档参数；
基于所述文档参数生成Maven插件，以在工程中执行命令时使用所述Maven插件生成目标接口文档。


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


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


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


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

【专利技术属性】
技术研发人员：陈浩，章多亮，
申请(专利权)人：江苏满运软件科技有限公司，
类型：发明
国别省市：江苏;32