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

说明书

本发明提供一种接口文档生成方法及装置、电子设备、存储介质，该方法应用于基于Swagger的代码注解进行参数定义的程序代码，包括：接收接口文档生成请求；依据所述接口文档生成请求确定目标程序代码，并获取与所述目标程序代码关联的预定义的接口文档模板；解析所述目标程序代码对应的代码注解，从所述代码注解中获取所述目标程序代码的属性信息；将所述属性信息导入所述预定义的接口文档模板中，生成与所述接口文档生成请求对应的接口文档；展示所述接口文档。本发明实施例应用于基于Swagger的代码注解进行参数定义的程序代码，可以实现代码注解的规范化和通用性；根据目标程序代码自动生成接口文档，并提高了接口文档的准确性。

技术领域

本发明涉及计算机技术领域，特别是涉及接口文档生成方法及装置、电子设备、存储介质。

背景技术

在当今互联网时代，信息系统支撑着线上服务的运转，信息系统内部的前端服务和后台服务之间以及信息系统之间的交互，都是通过API(Application ProgrammingInterface，应用程序接口)进行通信的，目前最流行的Web数据接口设计规范就是RESTful(Representational State Transfer，表述性状态转移)，而且在当前微服务模式下，根据业务划分的领域越来越多，每个领域物理上相互独立，领域之间进行通信的API越来越多，所以RESTful API就是信息系统的骨架，是系统开发人员在进行交流和并行开发过程中必不可少的资料，通常需要在开发工作之前就要定义好相应的入参和出参，也就是自身通过入参去请求，希望得到相应的出参响应，多个API的交互就将整个系统串联起来。

在现有技术中，对API接口的维护方式是通过Excel进行，由于实际业务的复杂性以及开发过程中需求的变更，都会导致API定义的变化，开发人员的工作饱和度很大，往往为了赶进度，直接在程序里修改了API，实时去维护API在文档中的变化，是一件非常繁杂且耗时的工作。所以随着系统开发工作的推进，最终程序实现的和起初定义的API往往有很大出入，这在后期系统维护阶段或进行工作交接时，给其他人员造成很大的困难，且在需要与其他系统进行通信时，提供的API接口文档通常不是准确的，严重影响双方工作效率。

发明内容

鉴于上述问题，提出了本发明以便提供克服上述问题或者至少部分地解决上述问题的接口文档生成方法及装置、电子设备、存储介质，包括：

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

接收接口文档生成请求；

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

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

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

展示所述接口文档。

优选地，所述方法还包括：

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

优选地，所述方法还包括：

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

优选地，在所述接收接口文档生成请求的步骤之前，还包括：

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

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

优选地，所述集成Ueditor文本编辑器的步骤，包括：