[发明专利]接口文档生成方法、装置、计算机设备和存储介质

说明书

本申请涉及研发管理技术领域内的一种接口文档生成方法、装置、计算机设备和存储介质。所述方法包括：获取原生swagger组件，根据所述原生swagger组件生成JSON文件流；根据接口名称从所述JSON文件流中读取多个接口的接口信息，所述接口信息包括基础信息以及属性信息；将读取到的每个接口的基础信息以及属性信息封装在预先定义的表格对象中，得到封装后的表格对象；利用封装后的表格对象，生成与所述原生swagger组件对应的接口文档。采用本方法能够有效提高接口信息的可读性，便于不熟悉JSON语言的人员直观了解接口信息。

技术领域

本申请涉及计算机技术领域，特别是涉及一种接口文档生成方法、装置、计算机设备和存储介质。

背景技术

随着互联网技术的发展，网站的前端与后端开始分离。在前端与后端的交互过程中API(Application Programming Interface，应用程序编程接口)接口便成为一个重要的途径。API文档也因此成了开发人员与其他工作人员的重要纽带。Swagger是一种API开发工具，可用于API的设计以及编写API文档。现有的swagger组件只能生成.JSON格式的API文档。然而.JSON格式的API文档不仅内容无序，而且存在较多冗余数据以及JSON代码。为了便于其他工作人员直观了解接口信息，需要将.JSON格式的API文档转换为常见文档格式。因此，如何快速有效的对.JSON格式的API文档进行格式转换成为目前需要解决的一个技术问题。

发明内容

基于此，有必要针对上述技术问题，提供一种能够快速有效的对.JSON格式的API文档进行格式转换的接口文档生成方法、装置、计算机设备和存储介质。

一种接口文档生成方法，所述方法包括：

获取原生swagger组件，根据所述原生swagger组件生成JSON文件流；

根据接口名称从所述JSON文件流中读取多个接口的接口信息，所述接口信息包括基础信息以及属性信息；

将读取到的每个接口的基础信息以及属性信息封装在预先定义的表格对象中，得到封装后的表格对象；

利用封装后的表格对象，生成与所述原生swagger组件对应的接口文档。

在其中一个实施例中，所述根据接口名称从所述JSON文件流中读取多个接口的接口信息包括：

根据接口名称从所述JSON文件流中读取第一个接口的基础信息，所述基础信息包括出入参对象；

根据所述出入参对象在对应的属性信息中读取出入参对象信息；

根据接口名称读取下一个接口的基础信息，直至所述JSON文件流中所有接口的基础信息与对应的出入参对象信息读取完毕。

在其中一个实施例中，所述将读取到的每个接口的基础信息以及属性信息封装在预先定义的表格对象中包括：

在读取到的接口信息中提取接口名称；

在预先定义的表格对象中创建与所述接口名称相对应的表格页面；

通过所述表格页面封装与所述接口名称对应的基础信息以及属性信息。

在其中一个实施例中，所述通过所述表格页面封装与所述接口名称对应的基础信息以及属性信息包括：

根据接口名称对应的出入参对象在所述表格页面中生成对象字段名；

根据所述出入参对象的属性信息填充与所述对象字段名对应的对象字段值；

利用所述对象字段名与对象字段值生成与所述接口名称对应的表格。

在其中一个实施例中，所述表格对象包括多个预定义字段；所述方法还包括：