接口说明文档生成方法、装置、设备及存储介质与流程

1.本技术属于计算机技术领域，尤其涉及一种接口说明文档生成方法、装置、设备及存储介质。


背景技术：

2.在系统集成中，依赖于应用程序接口(application programming interface，api)接口说明文档内的特定信息进行相应代码开发或系统配置。传统方法通过人工编写生成接口说明文档，效率较低。现已有自动生成接口说明文档的方法，但是该方法依赖于第三方插件，需要人工下载安装第三方插件后才能生成接口说明文档，效率较低。


技术实现要素：

3.本技术实施例提供一种接口说明文档生成方法、装置、设备及存储介质，能够解决利用第三方插件自动生成接口说明文档的方法效率较低的问题。
4.第一方面，本技术实施例提供一种接口说明文档生成方法，方法应用于平台服务器，方法包括：
5.接收终端发送的接口说明文档生成指令；
6.响应于接口说明文档生成指令，解析接口模块的接口，得到接口解析数据；
7.基于接口解析数据生成接口说明文档。
8.在一种实施例中，接口解析数据包括api类型数据和api说明数据；
9.基于接口解析数据生成接口说明文档，包括：
10.按api类型数据对api说明数据分类，生成接口说明文档。
11.在一种实施例中，方法还包括：
12.以markdown的格式，将api说明数据转换成文本信息，得到markdown文档。
13.在一种实施例中，方法还包括：
14.向云服务器发送markdown文档；
15.接收云服务器发送的存储markdown文档的地址，地址用于查询markdown文档。
16.在一种实施例中，api说明数据包括：api说明对象数据和api说明对象数据对应的api说明内容数据；
17.方法还包括：
18.提取接口说明文档的类目数据，类目数据表征api类型数据和api说明对象数据的对应关系；
19.接收终端发送的接口说明文档汇总展示指令；
20.响应于接口说明文档汇总展示指令，根据地址从云服务器中获取markdown文档；
21.向终端发送类目数据和markdown文档，用于终端根据类目数据分类显示markdown文档。
22.第二方面，本技术实施例提供一种接口说明文档生成装置，装置应用于平台服务
器，装置包括：
23.接收模块，用于接收终端发送的接口说明文档生成指令；
24.解析模块，用于响应于接口说明文档生成指令，解析接口模块的接口，得到接口解析数据；
25.生成模块，用于基于接口解析数据生成接口说明文档。
26.在一种实施例中，接口解析数据包括api类型数据和api说明数据；
27.生成模块，具体用于按api类型数据对api说明数据分类，生成接口说明文档。
28.在一种实施例中，装置还包括编排模块；
29.编排模块，用于以markdown的格式，将api说明数据转换成文本信息，得到markdown文档。
30.在一种实施例中，装置还包括发送模块；
31.发送模块，用于向云服务器发送markdown文档；
32.接收模块，还用于接收云服务器发送的存储markdown文档的地址，地址用于查询markdown文档。
33.在一种实施例中，api说明数据包括：api说明对象数据和api说明对象数据对应的api说明内容数据；
34.装置还包括提取模块和获取模块；
35.提取模块，用于提取接口说明文档的类目数据，类目数据表征api类型数据和api说明对象数据的对应关系；
36.接收模块，还用于接收终端发送的接口说明文档汇总展示指令；
37.获取模块，用于响应于接口说明文档汇总展示指令，根据地址从云服务器中获取markdown文档；
38.发送模块，还用于向终端发送类目数据和markdown文档，用于终端根据类目数据分类显示markdown文档。
39.第三方面，本技术实施例提供一种接口说明文档生成设备，包括：存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，计算机程序被处理器执行时实现上述的接口说明文档生成方法。
40.第四方面，本技术实施例提供一种计算机可读存储介质，计算机可读存储介质上存储有信息传递的实现程序，程序被处理器执行时实现上述的接口说明文档生成方法。
41.本技术实施例的接口说明文档生成方法、装置、设备及存储介质，接收并响应于终端发送的接口说明文档生成指令，解析接口模块的接口，得到api类型数据和api说明数据，然后按api类型数据对api说明数据分类，得到接口说明文档，无需安装第三方插件即可自动生成接口说明文档，效率较高。
附图说明
42.为了更清楚地说明本技术实施例的技术方案，下面将对本技术实施例中所需要使用的附图作简单的介绍，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。
43.图1是本技术实施例提供的一种接口说明文档生成方法的流程示意图；
44.图2是本技术实施例提供的一种markdown文档的显示状态示意图；
45.图3是本技术实施例提供的一种接口说明文档生成装置的结构示意图；
46.图4是本技术实施例提供的一种接口说明文档生成设备的结构示意图。
具体实施方式
47.下面将详细描述本技术的各个方面的特征和示例性实施例，为了使本技术的目的、技术方案及优点更加清楚明白，以下结合附图及具体实施例，对本技术进行进一步详细描述。应理解，此处所描述的具体实施例仅被配置为解释本技术，并不被配置为限定本技术。对于本领域技术人员来说，本技术可以在不需要这些具体细节中的一些细节的情况下实施。下面对实施例的描述仅仅是为了通过示出本技术的示例来提供对本技术更好的理解。
48.需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括
……”
限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。
49.现已有利用第三方插件自动生成接口说明文档的方法，但是该方法依赖于第三方插件，需要人工下载安装第三方插件后才能生成接口说明文档，效率较低。
50.为了解决现有技术问题，本技术实施例提供了一种接口说明文档生成方法、装置、设备及存储介质。本技术实施例通过接收并响应于终端发送的接口说明文档生成指令，解析接口模块的接口，得到api类型数据和api说明数据，然后按api类型数据对api说明数据分类，得到接口说明文档，无需安装第三方插件即可生成接口说明文档，效率较高。下面首先对本技术实施例所提供的接口说明文档生成系统进行介绍：
51.本技术实施例所提供的接口说明文档生成系统包括：平台服务器、终端、云服务器；
52.其中，平台服务器设置有接口模块，在系统集成中，依赖于应用程序接口的接口说明文档内的特定信息进行相应代码开发或系统配置，解析该接口模块，能够得到用于生成接口说明文档的接口解析数据。平台服务器还设置有数据库，用于存储信息。
53.终端用于接收用户指令，还可以为用户展示接口说明文档等信息。
54.云服务器可以作为数据存储单位，分担平台服务器的存储任务，保证平台服务器的负载均衡。
55.基于上述接口说明文档生成系统，本技术实施例提供一种接口说明文档生成方法，下面对该方法进行介绍。
56.图1示出了本技术一个实施例提供的接口说明文档生成方法的流程示意图。如图1所示，该方法可以包括以下步骤：
57.s101，平台服务器接收终端发送的接口说明文档生成指令。
58.其中，终端发送的接口说明文档生成指令可以基于用户对终端显示的操作界面的
操作而生成。平台服务器与终端通信连接，平台服务器能够接收终端发送的接口说明文档生成指令。
59.s102，平台服务器响应于接口说明文档生成指令，解析接口模块的接口，得到接口解析数据。
60.其中，在平台服务器接收到接口说明文档生成指令后，触发解析接口模块的接口的动作，解析接口模块的接口，能够得到接口解析数据。
61.s103，基于所述接口解析数据生成接口说明文档。
62.在一种实施例中，接口解析数据可以包括api类型数据和api说明数据；s103可以包括：
63.平台服务器按所述api类型数据对所述api说明数据分类，生成接口说明文档。
64.本技术实施例通过接收并响应于终端发送的接口说明文档生成指令，解析接口模块的接口，得到api类型数据和api说明数据，然后按api类型数据对api说明数据分类，得到接口说明文档，无需安装第三方插件即可生成接口说明文档，效率较高。
65.其中，解析得到api类型数据和api说明数据后，即可根据api类型数据和api说明数据的对应关系，按照api类型数据是否相同对api说明数据进行分类，将api类型数据相同的api说明数据划分为一类，分类后，能够得到接口说明文档。
66.在一种实施例中，该方法还包括：
67.s104，以markdown的格式，将所述api说明数据转换成文本信息，得到所述markdown文档。
68.其中，markdown是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，将api说明数据编排为markdown文档，易于用户读写api说明数据。
69.s105，平台服务器向云服务器发送markdown文档。
70.其中，平台服务器与云服务器通信连接，平台服务器能够向云服务器发送markdown文档，云服务器在接收markdown文档时，可以应用对象存储(cloud object storage，cos)进行接收存储。
71.s106，平台服务器接收云服务器发送的存储markdown文档的地址。
72.其中，该地址可以用于查询markdown文档，考虑到存在用户对api说明数据使用需求不是即时的情况，用户可能需要接口模块整个使用周期的接口说明文档，本技术实施例将markdown文档进行存储，并且，将该markdown文档存储到云服务器中，有效的减小了平台服务器的存储压力，保证了平台服务器的负载均衡。
73.在一种实施例中，api说明数据包括：api说明对象数据和api说明对象数据对应的api说明内容数据。api说明对象数据可以包括如下至少一项：api名称，api描述信息，api地址，api请求类型，api参数，api字段列表，该方法还可以包括：
74.s107，平台服务器提取接口说明文档的类目数据，类目数据表征api类型数据和api说明对象数据的对应关系。
75.其中，接口说明文档是通过api类型数据对api说明数据分类得到的，相应的，接口说明文档包括从高到低不同层级的类目数据，该类目数据表征api类型数据和api说明对象数据的对应关系，平台服务器能够从接口说明文档提取到类目数据。
76.s108，平台服务器接收终端发送的接口说明文档汇总展示指令。
77.其中，终端发送的接口说明文档汇总展示指令可以基于用户对终端显示的操作界面的操作而生成，表明用户想要观看接口说明文档。
78.s109，平台服务器响应于接口说明文档汇总展示指令，根据地址从云服务器中获取markdown文档。
79.其中，平台服务器存储有markdown文档在云服务器的存储地址，根据该地址即可从云服务器中获取markdown文档。
80.s110，平台服务器向终端发送类目数据和markdown文档。
81.s111，终端根据类目数据分类显示markdown文档。
82.其中，类目数据表征api类型数据和api说明对象数据的对应关系，终端可以根据类目数据分类显示markdown文档，markdown文档的显示状态可以如图2所示。
83.本技术实施例通过接收并响应于终端发送的接口说明文档生成指令，解析接口模块的接口，得到api类型数据和api说明数据，然后按api类型数据对api说明数据分类，得到接口说明文档，无需安装第三方插件即可生成接口说明文档，效率较高。
84.图1-2描述了接口说明文档生成方法，下面结合附图3和附图4描述本技术实施例提供的装置。
85.图3示出了本技术一个实施例提供的接口说明文档生成装置的结构示意图，图3所示装置中各模块具有实现图1中各个步骤的功能，并能达到其相应技术效果。如图3所示，该装置可以包括：
86.接收模块301，用于接收终端发送的接口说明文档生成指令；
87.解析模块302，用于响应于接口说明文档生成指令，解析接口模块的接口，得到接口解析数据；
88.生成模块303，用于基于所述接口解析数据生成接口说明文档。
89.本技术实施例通过接收并响应于终端发送的接口说明文档生成指令，解析接口模块的接口，得到api类型数据和api说明数据，然后按api类型数据对api说明数据分类，得到接口说明文档，无需安装第三方插件即可生成接口说明文档，效率较高。
90.在一种实施例中，接口解析数据包括api类型数据和api说明数据；
91.生成模块303，可以具体用于按api类型数据对api说明数据分类，生成接口说明文档。
92.在一种实施例中，装置还包括编排模块和发送模块；
93.编排模块，用于以markdown的格式，将所述api说明数据转换成文本信息，得到所述markdown文档；
94.发送模块，用于向云服务器发送markdown文档；
95.接收模块，用于接收云服务器发送的存储markdown文档的地址，地址用于查询markdown文档。
96.在一种实施例中，api说明数据包括：api说明对象数据和api说明对象数据对应的api说明内容数据；
97.装置还包括提取模块、提取模块；
98.提取模块，用于提取接口说明文档的类目数据，类目数据表征api类型数据和api说明对象数据的对应关系；
99.接收模块，用于接收终端发送的接口说明文档汇总展示指令；
100.提取模块，用于响应于接口说明文档汇总展示指令，根据地址从云服务器中获取markdown文档；
101.发送模块，用于向终端发送类目数据和markdown文档，用于终端根据类目数据分类显示markdown文档。
102.在一种实施例中，api说明对象数据包括如下至少一项：
103.api名称，api描述信息，api地址，api请求类型，api参数，api字段列表。
104.本技术实施例通过接收并响应于终端发送的接口说明文档生成指令，解析接口模块的接口，得到api类型数据和api说明数据，然后按api类型数据对api说明数据分类，得到接口说明文档，无需安装第三方插件即可生成接口说明文档，效率较高。
105.图4示出了本技术一个实施例提供的接口说明文档生成设备的结构示意图。如图4所示，该设备可以包括处理器401以及存储有计算机程序指令的存储器402。
106.具体地，上述处理器401可以包括中央处理器(central processing unit，cpu)，或者特定集成电路(application specific integrated circuit，asic)，或者可以被配置成实施本技术实施例的一个或多个集成电路。
107.存储器402可以包括用于数据或指令的大容量存储器。举例来说而非限制，存储器402可包括硬盘驱动器(hard disk drive，hdd)、软盘驱动器、闪存、光盘、磁光盘、磁带或通用串行总线(universal serial bus，usb)驱动器或者两个或更多个以上这些的组合。在一个实例中，存储器402可以包括可移除或不可移除(或固定)的介质，或者存储器402是非易失性固态存储器。存储器402可在综合网关容灾设备的内部或外部。
108.在一个实例中，存储器402可以是只读存储器(read only memory，rom)。在一个实例中，该rom可以是掩模编程的rom、可编程rom(prom)、可擦除prom(eprom)、电可擦除prom(eeprom)、电可改写rom(earom)或闪存或者两个或更多个以上这些的组合。
109.处理器401通过读取并执行存储器402中存储的计算机程序指令，以实现图1所示实施例中的方法，并达到图1所示实例执行其方法达到的相应技术效果，为简洁描述在此不再赘述。
110.在一个示例中，该接口说明文档生成设备还可包括通信接口403和总线410。其中，如图4所示，处理器401、存储器402、通信接口403通过总线410连接并完成相互间的通信。
111.通信接口403，主要用于实现本技术实施例中各模块、装置、单元和/或设备之间的通信。
112.总线410包括硬件、软件或两者，将在线数据流量计费设备的部件彼此耦接在一起。举例来说而非限制，总线可包括加速图形端口(accelerated graphics port，agp)或其他图形总线、增强工业标准架构(extended industry standard architecture，eisa)总线、前端总线(front side bus，fsb)、超传输(hyper transport，ht)互连、工业标准架构(industry standard architecture，isa)总线、无限带宽互连、低引脚数(lpc)总线、存储器总线、微信道架构(mca)总线、外围组件互连(pci)总线、pci-express(pci-x)总线、串行高级技术附件(sata)总线、视频电子标准协会局部(vlb)总线或其他合适的总线或者两个或更多个以上这些的组合。在合适的情况下，总线410可包括一个或多个总线。尽管本技术实施例描述和示出了特定的总线，但本技术考虑任何合适的总线或互连。
113.该接口说明文档生成设备可以执行本技术实施例中的接口说明文档生成方法，从而实现图1描述的接口说明文档生成方法的相应技术效果。
114.另外，结合上述实施例中的接口说明文档生成方法，本技术实施例可提供一种计算机存储介质来实现。该计算机存储介质上存储有计算机程序指令；该计算机程序指令被处理器执行时实现上述实施例中的任意一种接口说明文档生成方法。
115.需要明确的是，本技术并不局限于上文所描述并在图中示出的特定配置和处理。为了简明起见，这里省略了对已知方法的详细描述。在上述实施例中，描述和示出了若干具体的步骤作为示例。但是，本技术的方法过程并不限于所描述和示出的具体步骤，本领域的技术人员可以在领会本技术的精神后，作出各种改变、修改和添加，或者改变步骤之间的顺序。
116.以上所述的结构框图中所示的功能块可以实现为硬件、软件、固件或者它们的组合。当以硬件方式实现时，其可以例如是电子电路、专用集成电路(application specific integrated circuit，asic)、适当的固件、插件、功能卡等等。当以软件方式实现时，本技术的元素是被用于执行所需任务的程序或者代码段。程序或者代码段可以存储在机器可读介质中，或者通过载波中携带的数据信号在传输介质或者通信链路上传送。“机器可读介质”可以包括能够存储或传输信息的任何介质。机器可读介质的例子包括电子电路、半导体存储器设备、rom、闪存、可擦除rom(erom)、软盘、cd-rom、光盘、硬盘、光纤介质、射频(radio frequency，rf)链路，等等。代码段可以经由诸如因特网、内联网等的计算机网络被下载。
117.还需要说明的是，本技术中提及的示例性实施例，基于一系列的步骤或者装置描述一些方法或系统。但是，本技术不局限于上述步骤的顺序，也就是说，可以按照实施例中提及的顺序执行步骤，也可以不同于实施例中的顺序，或者若干步骤同时执行。
118.上面参考根据本技术的实施例的方法、装置(系统)和计算机程序产品的流程图和/或框图描述了本技术的各方面。应当理解，流程图和/或框图中的每个方框以及流程图和/或框图中各方框的组合可以由计算机程序指令实现。这些计算机程序指令可被提供给通用计算机、专用计算机、或其它可编程数据处理装置的处理器，以产生一种机器，使得经由计算机或其它可编程数据处理装置的处理器执行的这些指令使能对流程图和/或框图的一个或多个方框中指定的功能/动作的实现。这种处理器可以是但不限于是通用处理器、专用处理器、特殊应用处理器或者现场可编程逻辑电路。还可理解，框图和/或流程图中的每个方框以及框图和/或流程图中的方框的组合，也可以由执行指定的功能或动作的专用硬件来实现，或可由专用硬件和计算机指令的组合来实现。
119.以上所述，仅为本技术的具体实施方式，所属领域的技术人员可以清楚地了解到，为了描述的方便和简洁，上述描述的系统、模块和单元的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。应理解，本技术的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本技术揭露的技术范围内，可轻易想到各种等效的修改或替换，这些修改或替换都应涵盖在本技术的保护范围之内。