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

权利要求书

1.一种接口文档生成方法，其特征在于，应用于基于Swagger的代码注解进行参数定义的程序代码，所述方法包括：

接收接口文档生成请求；

依据所述接口文档生成请求确定目标程序代码，并获取与所述目标程序代码关联的预定义的接口文档模板；

解析所述目标程序代码对应的代码注解，从所述代码注解中获取所述目标程序代码的属性信息；

将所述属性信息导入所述预定义的接口文档模板中，生成与所述接口文档生成请求对应的接口文档；

展示所述接口文档。

2.根据权利要求1所述的方法，其特征在于，所述方法还包括：

响应于对所述接口文档的编辑操作，更新所述接口文档对应的目标程序代码，和/或响应于对所述目标程序代码的编辑操作，更新所述目标程序代码对应的接口文档。

3.根据权利要求1所述的方法，其特征在于，在所述接收接口文档生成请求的步骤之前，还包括：

集成Ueditor文本编辑器；所述Ueditor文本编辑器用于接收自定义的样式设置；

依据所述自定义的样式设置生成所述预定义的接口文档模板。

4.根据权利要求3所述的方法，其特征在于，所述集成Ueditor文本编辑器的步骤，包括：

获取Ueditor文本编辑器的源文件；

在前端框架对应的文件夹中添加所述源文件的源代码；

配置所述源文件的配置文件中的服务器地址；

将所述源文件引入所述前端框架的入口文件；

创建所述源文件的源代码和所述前端框架的双向数据绑定。

5.根据权利要求1所述的方法，其特征在于，所述属性信息包括描述信息、调用方式、入参信息及出参信息；所述解析所述目标程序代码对应的代码注解，并从所述代码注解中获取所述目标程序代码的属性信息的步骤，包括：

获取所述代码注解中包含第一标识注解对应的属性值，得到所述目标程序代码的描述信息；

获取所述代码注解中包含第二标识注解对应的属性值，得到所述目标程序代码的调用方式；

获取所述代码注解中包含第三标识注解对应的属性值，得到所述目标程序代码的入参信息；

获取所述代码注解中包含第四标识注解对应的属性值，得到所述目标程序代码的出参信息。

6.根据权利要求1所述的方法，其特征在于，所述接口文档生成请求包括类名，所述依据所述接口文档生成请求确定目标程序代码的步骤，包括：

获取所述类名对应的多个方法名；

将所述多个方法名依次确定为目标方法名；

依据所述目标方法名确定与所述目标方法名对应的目标程序代码。

7.根据权利要求1所述的方法，其特征在于，所述接口文档生成请求包括方法名，所述依据所述接口文档生成请求确定目标程序代码的步骤，包括：

将所述方法名确定为目标方法名；

依据所述目标方法名确定与所述目标方法名对应的目标程序代码。

8.一种接口文档生成的装置，其特征在于，应用于基于Swagger的代码注解进行参数定义的程序代码，所述装置包括：

接收文档生成请求模块，用于接收接口文档生成请求；

确定目标程序代码模块，用于依据所述接口文档生成请求确定目标程序代码，并获取与所述目标程序代码关联的预定义的接口文档模板；

获取属性信息模块，用于解析所述目标程序代码对应的代码注解，从所述代码注解中获取所述目标程序代码的属性信息；

导入属性信息模块，用于将所述属性信息导入所述预定义的接口文档模板中，生成与所述接口文档生成请求对应的接口文档；

展示接口文档模块，用于展示所述接口文档。

9.一种电子设备，其特征在于，包括处理器、存储器及存储在所述存储器上并能够在所述处理器上运行的计算机程序，所述计算机程序被所述处理器执行时实现如权利要求1至7中任一项所述的方法的步骤。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质上存储计算机程序，所述计算机程序被处理器执行时实现如权利要求1至7中任一项所述的方法的步骤。