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

权利要求书

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

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

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

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

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

2.根据权利要求1所述的方法，其特征在于，所述根据接口名称从所述JSON文件流中读取多个接口信息包括：

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

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

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

3.根据权利要求1所述的方法，其特征在于，所述将读取到的每个接口的基础信息以及属性信息封装在预先定义的表格对象中包括：

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

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

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

4.根据权利要求3所述的方法，其特征在于，所述通过所述表格页面封装与所述接口名称对应的基础信息以及属性信息包括：

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

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

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

5.根据权利要求3所述的方法，其特征在于，所述表格对象包括多个预定义字段；所述方法还包括：

在基础信息中读取与所述预定义字段对应的字段信息；

通过读取到的字段信息与多个预定义字段生成接口目录；所述接口目录中包括接口名称；

在所述接口目录中建立接口名称与对应表格页面之间的链接。

6.一种接口文档生成装置，其特征在于，所述装置包括：

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

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

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

文档生成模块，用于利用所述封装后的表格对象，生成对应的接口文档。

7.根据权利要求6所述的装置，其特征在于，所述信息读取模块还用于根据接口名称从所述JSON文件流中读取第一个接口的基础信息，所述基础信息包括出入参对象；根据所述出入参对象在对应的属性信息对象中读取出入参对象信息；根据接口名称读取下一个接口的基础信息，直至所述JSON文件流中所有接口的接口信息与对应的出入参对象信息读取完毕。

8.根据权利要求6所述的装置，其特征在于，所述信息封装模块还用于在读取到的接口信息中提取接口名称；在预先定义的表格对象中创建与所述接口名称相对应的表格页面；通过所述表格页面封装与所述接口名称对应的基础信息以及属性信息。

9.一种计算机设备，包括存储器和处理器，所述存储器存储有计算机程序，其特征在于，所述处理器执行所述计算机程序时实现权利要求1至5中任一项所述方法的步骤。

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