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

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

Interface document generation method and device, electronic equipment and storage medium

【技术实现步骤摘要】
接口文档生成方法及装置、电子设备、存储介质
本专利技术涉及计算机
，特别是涉及接口文档生成方法及装置、电子设备、存储介质。
技术介绍
在当今互联网时代，信息系统支撑着线上服务的运转，信息系统内部的前端服务和后台服务之间以及信息系统之间的交互，都是通过API(ApplicationProgrammingInterface，应用程序接口)进行通信的，目前最流行的Web数据接口设计规范就是RESTful(RepresentationalStateTransfer，表述性状态转移)，而且在当前微服务模式下，根据业务划分的领域越来越多，每个领域物理上相互独立，领域之间进行通信的API越来越多，所以RESTfulAPI就是信息系统的骨架，是系统开发人员在进行交流和并行开发过程中必不可少的资料，通常需要在开发工作之前就要定义好相应的入参和出参，也就是自身通过入参去请求，希望得到相应的出参响应，多个API的交互就将整个系统串联起来。在现有技术中，对API接口的维护方式是通过Excel进行，由于实际业务的复杂性以及开发过程中需求的变更，都会导致AP本文档来自技高网...

【技术保护点】
1.一种接口文档生成方法，其特征在于，应用于基于Swagger的代码注解进行参数定义的程序代码，所述方法包括：/n接收接口文档生成请求；/n依据所述接口文档生成请求确定目标程序代码，并获取与所述目标程序代码关联的预定义的接口文档模板；/n解析所述目标程序代码对应的代码注解，从所述代码注解中获取所述目标程序代码的属性信息；/n将所述属性信息导入所述预定义的接口文档模板中，生成与所述接口文档生成请求对应的接口文档；/n展示所述接口文档。/n

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，应用于基于Swagger的代码注解进行参数定义的程序代码，所述方法包括：
接收接口文档生成请求；
依据所述接口文档生成请求确定目标程序代码，并获取与所述目标程序代码关联的预定义的接口文档模板；
解析所述目标程序代码对应的代码注解，从所述代码注解中获取所述目标程序代码的属性信息；
将所述属性信息导入所述预定义的接口文档模板中，生成与所述接口文档生成请求对应的接口文档；
展示所述接口文档。


2.根据权利要求1所述的方法，其特征在于，所述方法还包括：
响应于对所述接口文档的编辑操作，更新所述接口文档对应的目标程序代码，和/或响应于对所述目标程序代码的编辑操作，更新所述目标程序代码对应的接口文档。


3.根据权利要求1所述的方法，其特征在于，在所述接收接口文档生成请求的步骤之前，还包括：
集成Ueditor文本编辑器；所述Ueditor文本编辑器用于接收自定义的样式设置；
依据所述自定义的样式设置生成所述预定义的接口文档模板。


4.根据权利要求3所述的方法，其特征在于，所述集成Ueditor文本编辑器的步骤，包括：
获取Ueditor文本编辑器的源文件；
在前端框架对应的文件夹中添加所述源文件的源代码；
配置所述源文件的配置文件中的服务器地址；
将所述源文件引入所述前端框架的入口文件；
创建所述源文件的源代码和所述前端框架的双向数据绑定。


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

【专利技术属性】
技术研发人员：王超，
申请(专利权)人：泰康保险集团股份有限公司，
类型：发明
国别省市：北京;11