[发明专利]一种在线实时生成接口文档的方法及设备

说明书

本申请的目的是提供一种在线实时生成接口文档的方法及设备，本申请通过进入展示业务功能的表格数据的第一页面；根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。从而可以在线实时生成及查看接口文档，根据线上的数据自动生成接口文档，避免纯手工线下维护带来的不准确性，同时可根据页面快速查看其准确的接口文档。

技术领域

本申请涉及计算机领域，尤其涉及一种在线实时生成接口文档的方法及设备。

背景技术

以往后台页面的接口文档都是开发人员线下手工维护，这种接口文档的维护方式耗费精力，且很难根据页面快速找到接口文档维护的位置，当接口有更新但没及时手动同步，导致接口文档不准确，时间长了就不再具备可靠的参考阅读意义。

发明内容

本申请的一个目的是提供一种在线实时生成接口文档的方法及设备，解决现有技术中手工线下维护带来的不准确性以及不及时的问题。

根据本申请的一个方面，提供了一种在线实时生成接口文档的方法，该方法包括：

进入展示业务功能的表格数据的第一页面；

根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；

基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。

可选地，基于所述操作向第二页面传递接口相关数据之前，包括：

将所述接口相关数据与所述第一页面的页面组件解耦，其中，所述接口相关数据包括接口链接、接口入参、接口出参配置描述、实际请求获得的表格数据、接口文档所需的接口字段及接口示例。

可选地，基于所述操作向第二页面传递接口相关数据，包括：

当所述第一页面与所述第二页面的窗口为同一域名时，则基于浏览器中的本地存储方式向所述第二页面传递接口相关数据；

当所述第一页面与所述第二页面的窗口为不同一域名时，则基于浏览器中的跨源通信方式向跨域的第二页面传递接口相关数据。

可选地，基于所述接口相关数据生成接口文档，包括：

将所述接口出参配置描述和表格数据中的行数据以字段进行绑定关联关系，组合成新的数据结构，其中，所述新的数据结构包括字段标识、字段类型、字段名称以及字段示例；

基于所述新的数据结构以及所述接口相关数据进行循环渲染生成接口文档。

可选地，进入展示业务功能的表格数据的第一页面之后，包括：

获取基于低代码平台构建的页面基础JSON数据。

可选地，对所述目标表格数据进行查看接口文档的操作，包括：

在所述目标表格数据指定的区域展示查看接口文档按钮；

获取用户对所述查看接口文档按钮的操作以进入第二页面。

可选地，将所述接口相关数据与所述第一页面的页面组件解耦，包括：

根据所述接口相关数据将所述第一页面的页面组件中的展示型组件封装成sdk，以进行解耦。

根据本申请另一个方面，还提供了一种在线实时生成接口文档的设备，该设备包括：

进入装置，用于进入展示业务功能的表格数据的第一页面；

操作装置，用于根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；