一种在线实时生成接口文档的方法及设备与流程

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


背景技术：

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


技术实现要素：

3.本技术的一个目的是提供一种在线实时生成接口文档的方法及设备，解决现有技术中手工线下维护带来的不准确性以及不及时的问题。
4.根据本技术的一个方面，提供了一种在线实时生成接口文档的方法，该方法包括：
5.进入展示业务功能的表格数据的第一页面；
6.根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；
7.基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。
8.可选地，基于所述操作向第二页面传递接口相关数据之前，包括：
9.将所述接口相关数据与所述第一页面的页面组件解耦，其中，所述接口相关数据包括接口链接、接口入参、接口出参配置描述、实际请求获得的表格数据、接口文档所需的接口字段及接口示例。
10.可选地，基于所述操作向第二页面传递接口相关数据，包括：
11.当所述第一页面与所述第二页面的窗口为同一域名时，则基于浏览器中的本地存储方式向所述第二页面传递接口相关数据；
12.当所述第一页面与所述第二页面的窗口为不同一域名时，则基于浏览器中的跨源通信方式向跨域的第二页面传递接口相关数据。
13.可选地，基于所述接口相关数据生成接口文档，包括：
14.将所述接口出参配置描述和表格数据中的行数据以字段进行绑定关联关系，组合成新的数据结构，其中，所述新的数据结构包括字段标识、字段类型、字段名称以及字段示例；
15.基于所述新的数据结构以及所述接口相关数据进行循环渲染生成接口文档。
16.可选地，进入展示业务功能的表格数据的第一页面之后，包括：
17.获取基于低代码平台构建的页面基础json数据。
18.可选地，对所述目标表格数据进行查看接口文档的操作，包括：
19.在所述目标表格数据指定的区域展示查看接口文档按钮；
20.获取用户对所述查看接口文档按钮的操作以进入第二页面。
21.可选地，将所述接口相关数据与所述第一页面的页面组件解耦，包括：
22.根据所述接口相关数据将所述第一页面的页面组件中的展示型组件封装成sdk，以进行解耦。
23.根据本技术另一个方面，还提供了一种在线实时生成接口文档的设备，该设备包括：
24.进入装置，用于进入展示业务功能的表格数据的第一页面；
25.操作装置，用于根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；
26.生成装置，用于基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。
27.根据本技术又一个方面，还提供了一种在线实时生成接口文档的设备，所述设备包括：
28.一个或多个处理器；以及
29.存储有计算机可读指令的存储器，所述计算机可读指令在被执行时使所述处理器执行如前述所述方法的操作。
30.根据本技术再一个方面，还提供了一种计算机可读介质，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现如前述所述的方法。
31.与现有技术相比，本技术通过进入展示业务功能的表格数据的第一页面；根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。从而可以在线实时生成及查看接口文档，根据线上的数据自动生成接口文档，避免纯手工线下维护带来的不准确性，同时可根据页面快速查看其准确的接口文档。
附图说明
32.通过阅读参照以下附图所作的对非限制性实施例所作的详细描述，本技术的其它特征、目的和优点将会变得更明显：
33.图1示出根据本技术的一个方面提供的一种在线实时生成接口文档的方法流程示意图；
34.图2示出本技术一实施例中生成接口文档的字段的示意图；
35.图3示出本技术一实施例中基于低代码平台的在线实时生成接口文档的流程示意图；
36.图4示出本技术又一个方面提供的一种在线实时生成接口文档的设备的结构示意图。
37.附图中相同或相似的附图标记代表相同或相似的部件。
具体实施方式
38.下面结合附图对本技术作进一步详细描述。
39.在本技术一个典型的配置中，终端、服务网络的设备和可信方均包括一个或多个处理器(例如中央处理器(central processing unit，cpu))、输入/输出接口、网络接口和
内存。
40.内存可能包括计算机可读介质中的非永久性存储器，随机存取存储器(random access memory，ram)和/或非易失性内存等形式，如只读存储器(read only memory，rom)或闪存(flash ram)。内存是计算机可读介质的示例。
41.计算机可读介质包括永久性和非永久性、可移动和非可移动媒体可以由任何方法或技术来实现信息存储。信息可以是计算机可读指令、数据结构、程序的模块或其他数据。计算机的存储介质的例子包括，但不限于相变内存(phase-change ram，pram)、静态随机存取存储器(static random access memory，sram)、动态随机存取存储器(dynamic random access memory，dram)、其他类型的随机存取存储器(ram)、只读存储器(rom)、电可擦除可编程只读存储器(electrically erasable programmable read-only memory，eeprom)、快闪记忆体或其他内存技术、只读光盘只读存储器(compact disc read-only memory，cd-rom)、数字多功能光盘(digital versatile disk，dvd)或其他光学存储、磁盒式磁带，磁带磁盘存储或其他磁性存储设备或任何其他非传输介质，可用于存储可以被计算设备访问的信息。按照本文中的界定，计算机可读介质不包括非暂存电脑可读媒体(transitory media)，如调制的数据信号和载波。
42.图1示出根据本技术的一个方面提供的一种在线实时生成接口文档的方法流程示意图，该方法包括：步骤s11～步骤s13，其中，步骤s11，进入展示业务功能的表格数据的第一页面；步骤s12，根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；步骤s13，基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。从而可以在线实时生成及查看接口文档，根据线上的数据自动生成接口文档，避免纯手工线下维护带来的不准确性，同时可根据页面快速查看其准确的接口文档。
43.具体地，在步骤s11中，进入展示业务功能的表格数据的第一页面；在此，在后台应用中，存在着大量的表格相关的网页，以拖拽生成后台页面的低代码平台为基础，进行构建页面的相关数据，从而再以数据为基础生成在线的接口文档。获取相关数据时，进行页面初始化，进入第一页面，该第一页面是可以展示业务功能的表格数据的页面，即后台应用中原有存储表格数据的相关页面，进而可以在该第一页面中选择所需要的业务功能对应的表格数据。
44.具体地，在步骤s12中，根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；在此，有些业务功能表格在不输入筛选条件就可以展示出表格数据，有些需要输入筛选条件才能展示表格数据。根据搜索条件可以在第一页面中进行选定所需的目标表格，进而展示表格数据，该搜索条件可以为全部也可以按照业务功能选择出部分，在第一页面中设置筛选条件的搜索框或者关键词查找框等，从而根据用户输入的搜索条件进行搜索出目标表格数据。当看到目标表格数据时，对该目标表格数据进行查看接口文档操作，进而进入生成接口文档的流程。
45.具体地，在步骤s13中，基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。在此，进入查看接口文档的操作后，第一页面向第二页面传递接口相关数据，该第二页面为用于生成接口文档的新打开的页面，第一页面将接口相关数据传递过后，第二页面上对传递的数据进行分析，根据分析结果在线实时生成接口文档。
46.在本技术一些实施例中，获取基于低代码平台构建的页面基础json数据。基于所述操作向第二页面传递接口相关数据之前，将所述接口相关数据与所述第一页面的页面组件解耦，其中，所述接口相关数据包括接口链接、接口入参、接口出参配置描述、实际请求获得的表格数据、接口文档所需的接口字段及接口示例。在此，生成接口文档需要接口相关的数据，所以首先要做的是将相关的数据与第一页面的页面组件进行解耦，其中数据用的是低代码平台拖拽生成的json数据，低代码平台为无需编码或通过少量代码就可以快速生成应用程序的开发平台；接口相关数据包括接口链接(apiurl)、接口入参(config)、接口出参配置描述(columns)以及实际请求获得的表格数据的行数据(rowdata)(实际列表中的一条数据)、接口文档中要用到的接口字段及接口示例等。
47.其中，根据所述接口相关数据将所述第一页面的页面组件中的展示型组件封装成sdk，以进行解耦。在此，页面组件解耦时使用的方案可以是将ui(展示型)组件封装成sdk，其中，sdk为软件开发工具包。
48.在本技术一些实施例，在步骤s13中，当所述第一页面与所述第二页面的窗口为同一域名时，则基于浏览器中的本地存储方式向所述第二页面传递接口相关数据；当所述第一页面与所述第二页面的窗口为不同一域名时，则基于浏览器中的跨源通信方式向跨域的第二页面传递接口相关数据。在此，生成的接口文档需要一个新的页面(即第二页面)承载，向新页面传递基于代码平台拖拽生成的json数据，如果第一页面的窗口与第二页面的窗口的域名相同，即新窗口与老窗口同一域名，则数据传递的方式主要使用浏览器中的本地存储方法等方式。而当接口文档需要用在多个后台应用中，需要考虑跨域问题，即当新窗口与老窗口不同一域名时，进行数据传递时，采用的是浏览器中自带的安全地实现跨源通信方法，来解决不同域不同窗口之间数据通讯问题。
49.在本技术一些实施例中，在步骤s13中，将所述接口出参配置描述和表格数据中的行数据以字段进行绑定关联关系，组合成新的数据结构，其中，所述新的数据结构包括字段标识、字段类型、字段名称以及字段示例；基于所述新的数据结构以及所述接口相关数据进行循环渲染生成接口文档。在此，将接口出参配置描述(columns)和rowdata(实际列表中的一条数据)以字段key为桥梁，通过for循环方法绑定关联关系，并组合出新的数据结构，其中，该新的数据结构可以为一个数组，元素包括字段标识、字段类型、字段名称、字段示例以及新窗口(接口文档)使用，如图2所示。从而在后台的列表应用中，可通过表格网页的基础数据快速生成准备实时的接口文档，包括接口文档的请求链接、请求方式、接口文档返回的数据(字段key、字段名称、字段类型及字段示例)。
50.在本技术一些实施例中，在步骤s12中，在所述目标表格数据指定的区域展示查看接口文档按钮；获取用户对所述查看接口文档按钮的操作以进入第二页面。在此，指定的区域比如为目标表格数据的左下角、右下角或上方等。如图3所示，进入页面根据搜索条件搜索出表格数据，展示表格手速节并在表格的指定的区域比如左下角展示出“查看接口文档”按钮，点击“查看接口文档”按钮进入第二页面并进行传递接口相关数据，进入生成接口文档的流程，打开新的窗口对接收到的数据进行分析后生成接口文档。从而基于低代码平台的在线实时生成及查看接口文档的功能完成。
51.此外，本技术实施例还提供了一种计算机可读介质，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现前述一种在线实时生成接口文档的方法。
52.与上文所述的方法相对应的，本技术还提供一种终端，其包括能够执行上述图1或图2或各个实施例所述的方法步骤的模块或单元，这些模块或单元可以通过硬件、软件或软硬结合的方式来实现，本技术并不限定。例如，在本技术一实施例中，还提供了一种在线实时生成接口文档的设备，所述设备包括：
53.一个或多个处理器；以及
54.存储有计算机可读指令的存储器，所述计算机可读指令在被执行时使所述处理器执行如前述所述方法的操作。
55.例如，计算机可读指令在被执行时使所述一个或多个处理器：
56.进入展示业务功能的表格数据的第一页面；
57.根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；
58.基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。
59.图4示出本技术又一个方面提供的一种在线实时生成接口文档的设备的结构示意图，所述设备包括：进入装置11、操作装置12及生成装置13，其中，进入装置11用于进入展示业务功能的表格数据的第一页面；操作装置12用于根据搜索条件在所述第一页面中搜索出目标表格数据，对所述目标表格数据进行查看接口文档的操作；生成装置13用于基于所述操作向第二页面传递接口相关数据，基于所述接口相关数据生成接口文档。
60.需要说明的是，进入装置11、操作装置12及生成装置13执行的内容分别与上述步骤s11、s12和s13中的内容相同或相应相同，为简明起见，在此不再赘述。
61.显然，本领域的技术人员可以对本技术进行各种改动和变型而不脱离本技术的精神和范围。这样，倘若本技术的这些修改和变型属于本技术权利要求及其等同技术的范围之内，则本技术也意图包含这些改动和变型在内。
62.需要注意的是，本技术可在软件和/或软件与硬件的组合体中被实施，例如，可采用专用集成电路(asic)、通用目的计算机或任何其他类似硬件设备来实现。在一个实施例中，本技术的软件程序可以通过处理器执行以实现上文所述步骤或功能。同样地，本技术的软件程序(包括相关的数据结构)可以被存储到计算机可读记录介质中，例如，ram存储器，磁或光驱动器或软磁盘及类似设备。另外，本技术的一些步骤或功能可采用硬件来实现，例如，作为与处理器配合从而执行各个步骤或功能的电路。
63.另外，本技术的一部分可被应用为计算机程序产品，例如计算机程序指令，当其被计算机执行时，通过该计算机的操作，可以调用或提供根据本技术的方法和/或技术方案。而调用本技术的方法的程序指令，可能被存储在固定的或可移动的记录介质中，和/或通过广播或其他信号承载媒体中的数据流而被传输，和/或被存储在根据所述程序指令运行的计算机设备的工作存储器中。在此，根据本技术的一个实施例包括一个装置，该装置包括用于存储计算机程序指令的存储器和用于执行程序指令的处理器，其中，当该计算机程序指令被该处理器执行时，触发该装置运行基于前述根据本技术的多个实施例的方法和/或技术方案。
64.对于本领域技术人员而言，显然本技术不限于上述示范性实施例的细节，而且在不背离本技术的精神或基本特征的情况下，能够以其他的具体形式实现本技术。因此，无论
从哪一点来看，均应将实施例看作是示范性的，而且是非限制性的，本技术的范围由所附权利要求而不是上述说明限定，因此旨在将落在权利要求的等同要件的含义和范围内的所有变化涵括在本技术内。不应将权利要求中的任何附图标记视为限制所涉及的权利要求。此外，显然“包括”一词不排除其他单元或步骤，单数不排除复数。装置权利要求中陈述的多个单元或装置也可以由一个单元或装置通过软件或者硬件来实现。第一，第二等词语用来表示名称，而并不表示任何特定的顺序。