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

权利要求书

1.一种在线实时生成接口文档的方法，其特征在于，所述方法包括：

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

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

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

2.根据权利要求1所述的方法，其特征在于，基于所述操作向第二页面传递接口相关数据之前，包括：

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

3.根据权利要求1所述的方法，其特征在于，基于所述操作向第二页面传递接口相关数据，包括：

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

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

4.根据权利要求2所述的方法，其特征在于，基于所述接口相关数据生成接口文档，包括：

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

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

5.根据权利要求1所述的方法，其特征在于，进入展示业务功能的表格数据的第一页面之后，包括：

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

6.根据权利要求1所述的方法，其特征在于，对所述目标表格数据进行查看接口文档的操作，包括：

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

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

7.根据权利要求2所述的方法，其特征在于，将所述接口相关数据与所述第一页面的页面组件解耦，包括：

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

8.一种在线实时生成接口文档的设备，其特征在于，所述设备包括：

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

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

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

9.一种在线实时生成接口文档的设备，其特征在于，所述设备包括：

一个或多个处理器；以及

存储有计算机可读指令的存储器，所述计算机可读指令在被执行时使所述处理器执行如权利要求1至7中任一项所述方法的操作。

10.一种计算机可读介质，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现如权利要求1至7中任一项所述的方法。