[发明专利]接口文档的生成方法、装置、服务器及存储介质

说明书

本申请提供一种接口文档的生成方法、装置、服务器及存储介质，涉及数据处理技术领域。该方法包括通过服务器获取脚本对象符号形式的接口文档；对脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；根据表格实体，得到文字形式的接口文档。通过对脚本对象符号形式的接口文档，进行解析，形成便于前端开发人员参考的文字形式的接口文档，提高了形成文字形式接口文档时的效率，节省了一定的人力资源，也便于对文字形式的接口文档更新。

技术领域

本发明涉及数据处理技术领域，具体而言，涉及一种接口文档的生成方法、装置、设备及存储介质。

背景技术

通常的项目研发可以包括前端研发和后端研发，后端需要为前端提供接口文档，以便前端可以根据接口文档完成相应的程序编写，因此，对于接口文档的编写变得越来越重要。

相关技术中，通过人工采用接口文档模板，根据网页应用开发前端和后端接口定义，以及对应的规范，手动编写文字形式的接口文档。

但是，相关技术中，通过人工手动编写文字形式的接口文档，会出现编写效率过低的问题，也浪费了不必要的人力资源。

发明内容

本发明的目的在于，针对上述现有技术中的不足，提供一种接口文档的生成方法、装置、服务器及存储介质，以解决相关技术中，通过人工手动编写文字形式的接口文档，会出现编写效率过低的问题，也浪费了不必要的人力资源的问题。

为实现上述目的，本发明实施例采用的技术方案如下：

第一方面，本发明实施例提供了一种网页应用系统中接口文档的生成方法，包括：

获取脚本对象符号形式的接口文档；

对所述脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体；

根据所述表格实体，得到文字形式的接口文档。

进一步地，所述表格实体包括：封装后的多个对象；所述将解析得到的接口表，封装成表格实体，包括：

将所述接口表封装为一个对象；

根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象。

进一步地，所述预设的参数划分规则为请求参数和响应参数的划分规则；所述根据预设的参数划分规则，将所述接口表中的参数，分别封装为一个对象，包括：

将所述接口表中的请求参数和响应参数，分别封装为一个对象。

进一步地，所述根据所述表格实体，得到文字形式的接口文档，包括：

根据所述表格实体，形成超文本标记语言HTML页面形式的接口文档；

将所述HTML页面形式的接口文档，转换成所述文字形式的接口文档。

进一步地，所述根据所述表格实体，形成超文本标记语言HTML页面形式的接口文档，包括：

根据预设的文字形式文档的表格模板，生成空白HTML页面，所述空白HTML页面包括：与所述表格模板相同的列表集合；

采用所述表格实体中的参数，对所述列表集合进行遍历，以将所述表格实体中的参数写入所述列表集合中对应位置，得到所述HTML页面形式的接口文档。

进一步地，所述根据所述表格实体，得到文字形式的接口文档，包括：

根据所述表格实体，调用预设的文字形式的文档生成接口，生成所述文字形式的接口文档。

进一步地，所述根据所述表格实体，调用预设的文字形式的文档生成接口，生成所述文字形式的接口文档之前，所述方法还包括：