CN110244945A - 接口文档生成方法及终端设备 - Google Patents
接口文档生成方法及终端设备 Download PDFInfo
- Publication number
- CN110244945A CN110244945A CN201910429578.1A CN201910429578A CN110244945A CN 110244945 A CN110244945 A CN 110244945A CN 201910429578 A CN201910429578 A CN 201910429578A CN 110244945 A CN110244945 A CN 110244945A
- Authority
- CN
- China
- Prior art keywords
- interface
- document
- interface document
- base
- function
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/20—Software design
- G06F8/22—Procedural
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/30—Creation or generation of source code
- G06F8/36—Software reuse
Landscapes
- Engineering & Computer Science (AREA)
- Software Systems (AREA)
- General Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Information Retrieval, Db Structures And Fs Structures Therefor (AREA)
Abstract
本发明适用于计算机应用技术领域,提供了一种接口文档生成方法、终端设备及计算机可读存储介质,包括:获取用户终端设备发送的接口文档查询信息;当预设的接口文档库中不存在接口文档查询信息中接口功能对应的接口文档时,根据用户终端发送的接口文档查询信息中的接口功能,确定与接口功能对应的所有基础接口文档,并将其整合为一个接口文档,在测试之后以供调用,不仅简化了接口开发的流程、接口管理和接口调用的过程,也提高了接口开发的效率。
Description
技术领域
本发明属于计算机应用技术领域,尤其涉及一种接口文档生成方法、终端设备及计算机可读存储介质。
背景技术
目前传统的接口文档处理都是通过人工的方式来完成。尤其是在一些涉及很多接口才能实现对应功能的管理系统中,如贷款场景的应用系统中,涉及到的接口多达数百种,每个客户对接口的需求往往不一样,A客户需要其中的5个接口,B用户可能需要10个接口。
现有技术中通过从已有的数百份接口文档中,找到不同客户需要的不同文档,再去做整理,最终合成一份文档给不同客户。这种方式,十分费时费力,也容易发生人工整理方式导致的错误,从而造成降低接口开发效率的问题。
发明内容
有鉴于此,本发明实施例提供了一种接口文档生成方法、终端设备及计算机可读存储介质,以解决现有技术中进行接口开发时面临的开发效率较低的问题。
本发明实施例的第一方面提供了一种接口文档生成方法,包括:
获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能;
当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;
根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;
发送所述目标接口文档至所述用户终端设备。
本发明实施例的第二方面提供了一种终端设备,包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序,所述处理器执行所述计算机程序时实现以下步骤:
获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能;
当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;
根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;
发送所述目标接口文档至所述用户终端设备。
本发明实施例的第三方面提供了一种终端设备,包括:
获取单元,用于获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能;
查询单元,用于当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;
整合单元,用于根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;
发送单元,用于发送所述目标接口文档至所述用户终端设备。
本发明实施例的第四方面提供了一种计算机可读存储介质,所述计算机存储介质存储有计算机程序,所述计算机程序包括程序指令,所述程序指令当被处理器执行时使所述处理器执行上述第一方面的方法。
本发明实施例与现有技术相比存在的有益效果是:
本发明实施例通过获取用户终端设备发送的接口文档查询信息;当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;对所述目标接口文档进行测试;若所述目标接口文档测试通过,则发送所述目标接口文档至所述用户终端设备。通过当预设的接口文档库中不存在接口文档查询信息中接口功能对应的接口文档时,根据用户终端发送的接口文档查询信息中的接口功能,将其整合为一个接口文档,并在测试之后以供调用,不仅简化了接口开发的流程、接口管理和接口调用的过程,也提高了接口开发的效率。
附图说明
为了更清楚地说明本发明实施例中的技术方案,下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍,显而易见地,下面描述中的附图仅仅是本发明的一些实施例,对于本领域普通技术人员来讲,在不付出创造性劳动性的前提下,还可以根据这些附图获得其他的附图。
图1是本发明实施例一提供的接口文档生成方法的流程图;
图2是本发明实施例二提供的接口文档生成方法的流程图;
图3是本发明实施例三提供的终端设备的示意图;
图4是本发明实施例四提供的终端设备的示意图。
具体实施方式
以下描述中,为了说明而不是为了限定,提出了诸如特定系统结构、技术之类的具体细节,以便透彻理解本发明实施例。然而,本领域的技术人员应当清楚,在没有这些具体细节的其它实施例中也可以实现本发明。在其它情况中,省略对众所周知的系统、装置、电路以及方法的详细说明,以免不必要的细节妨碍本发明的描述。
为了说明本发明所述的技术方案,下面通过具体实施例来进行说明。
参见图1,图1是本发明实施例一提供的接口文档生成方法的流程图。本实施例中接口文档生成方法的执行主体为终端设备。终端设备包括但不限于智能手机、平板电脑、可穿戴设备等移动终端设备,还可以是台式电脑等。如图所示的接口文档生成方法可以包括以下步骤:
S101:获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能。
随着软件项目规模的扩大,高效复用代码成为软件开发者们的共识,其中使用应用程序编程接口(Application Programming Interface,API)是代码复用的一种重要手段。通过接口文档,开发者们可以清楚、快速地了解到相关接口的功能、使用条件以及使用限制。例如,Java语言拥有大量的开发用户以及丰富的第三方开发框架,并且提供了规范的文档书写标准,吸引了相当数量的研究者。
示例性的,在Java源代码中的API文档以Javadoc注解的形式,在每个接口方法代码对应的地方进行注解,存在于源代码中。这样的文档可以通过Javadoc、Doxygen等文档抽取工具,形成html文档。通过文档抽取工具进行提取得到的Javadoc文档具有一定的结构特征。我们将Javadoc注解文档抽象成固定的结构,确定给每个结构对应的标签条目,不同的条目类型,其关键词的意义也有所不同,例如版本号、相关API等。
在本方案中,用户终端设备发送的接口文档查询信息包括接口功能等信息,以通过接口功能确定对该接口功能对应的接口文档,并根据运行该接口文档来处理数据。
可选的,还可以设定给一个接口选择界面,在用户端通过用户终端设备来选择用户所需要的接口文档,例如,将所有的接口文档按照接口功能的方式做成目录,用户通过浏览目录选择自己所需要的一个或者多个接口标识,通过用户选择的接口标识可以在接口库中直接确定接口标识所对应的接口文档。
S102:当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档。
本实施例中预设有接口文档库,用于存储各种类型的接口文档。并且,在接口文档库中,将每个接口文档按照文档标识进行存储,其存储方式可以是根据相关的功能或者相同的类型来存储。示例性地,在接口文档库中,我们可以按照获取数据、处理数据、发送数据的数据处理功能,来将不同的接口文档存储至接口文档库中,还可以根据不同接口文档的类型来进行存储,示例性地,接口文档按照数据处理方式的不同可以分为输入型或者输出型接口,我们将接口文档按照输入或者输出的类型来进行存储,通过这种方式,可以提高接口文档的管理、查找和调用效率。
在获取到接口文档查询信息之后,我们在接口文档库中查找与接口文档查询信息对应的基础接口文档的文档标识。需要说明的是,用户终端设备所发送的接口文档查询信息对应的接口文档可能是一个,也可能是多个,当接口文档库中所存储的接口文档不能满足接口文档查询信息对应的功能时,我们需要根据接口文档库中的接口文档信息,确定至少两个基础接口文档,将确定出来的所有基础接口文档整合,作为与接口文档查询信息对应的接口文档。
具体的,在接口文档库中查找与接口文档查询信息对应的基础接口文档时,先对接口文档查询信息进行量化,确定接口文档查询信息中每个接口元素的接口元素值。本方案中的接口文档的接口元素可以包括:接口地址、接口请求方式、接口入参要求、接口出参要求。通过根据接口文档查询信息确定用户所需要的接口文档的接口元素值。本方案中的接口文档库中预存有每个接口文档的接口元素值,通过计算接口文档库中预存有每个接口文档的接口元素值与接口文档查询信息中的接口元素值,两者之间的相似度,量化两者之间针对于每个接口元素的相似情况。最后通过衡量接口文档库中的接口文档和接口文档查询信息中的接口元素值之间的相似程度,来确定每个接口元素中相似程度最高的接口文档为当前接口元素对应的基础接口文档,并确定基础接口文档的文档标识。
需要说明的是,本实施例中在选定接口文档库中的基础接口文档时,是根据接口文档查询信息和接口文档之间在每个接口元素上的相似程度来确定的,因此,接口文档查询信息中包括了几个接口元素,与其对应的,确定出来的基础接口文档便对应有多少个。
S103:根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档。
在确定了基础接口文档之后,根据基础接口文档的文档标识,从接口文档库中下载基础接口文档,并生成一个空白接口文档,这个空白接口文档中包括每个文档元素对应的文档格式,根据每个基础接口文档,确定目标接口文档的每个文档元素对应的数据,根据空白接口文档中的文档格式,每个文档元素对应的数据写入空白接口文档中,得到目标接口文档。
S104:发送所述目标接口文档至所述用户终端设备。
在对基础接口文档进行整合得到目标接口文档之后,我们所得到的目标接口文档即为与用户终端设备发送的接口文档查询信息对应的接口文档,则发送目标接口文档至用户终端设备,以使用户终端设备可以直接调用已经整合完成的目标接口文档,提高的接口文档查询、生成以及调用的效率。
上述方案,通过获取用户终端设备发送的接口文档查询信息;当预设的接口文档库中不存在接口文档查询信息中接口功能对应的接口文档时,根据用户终端发送的接口文档查询信息中的接口功能,确定与接口功能对应的所有基础接口文档,并将其整合为一个接口文档,在测试之后以供调用,不仅简化了接口开发的流程、接口管理和接口调用的过程,也提高了接口开发的效率。
参见图2,图2是本发明实施例二提供的接口文档生成方法的流程图。本实施例中接口文档生成方法的执行主体为终端设备。终端设备包括但不限于智能手机、平板电脑、可穿戴设备等移动终端设备,还可以是台式电脑等。如图所示的接口文档生成方法可以包括以下步骤:
S201:获取用户终端设备发送的接口文档查询信息。
在本实施例中S201与图1对应的实施例中S101的实现方式完全相同,具体可参考图1对应的实施例中的S101的相关描述,在此不再赘述。
S202:当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识。
本实施例中预设有接口文档库,用于存储各种类型的接口文档。并且,在接口文档库中,将每个接口文档按照文档标识进行存储,其存储方式可以是根据相关的功能或者相同的类型来存储。在获取到接口文档查询信息之后,当预设的接口文档库中不存在接口功能对应的接口文档时,我们在接口文档库中查找与接口文档查询信息对应的基础接口文档的文档标识。通过这种方式,可以提高接口文档的管理、查找和调用效率。
进一步的,本实施例中的步骤S202可以具体包括步骤S2021~S2023:
S2021:当预设的接口文档库中不存在所述接口功能对应的接口文档时,对所述接口文档查询信息进行量化,确定所述接口文档查询信息中的接口元素值;所述接口元素值用于表示接口文档中各个接口元素的信息;所述接口元素用于表示所述接口文档的组成部分。
在获取到接口文档查询信息之后,当预设的接口文档库中不存在接口功能对应的接口文档时,对接口文档查询信息进行量化,确定接口文档查询信息中的接口元素值。本方案中的接口文档的接口元素可以包括:接口地址、接口请求方式、接口入参要求、接口出参要求。通过分析接口文档查询信息确定用户所需要的接口文档包含的接口功能对应的每个接口元素中对应的接口元素值。
具体的,设接口文档库中的每个接口文档量化之后的接口元素值分别为:add_d,req_d,enpa_d,expa_d,分别用于表示接口文档库中预存的每个接口文档所包括的接口分支功能的量化值;接口文档查询信息确定用户所需要的接口文档量化之后的接口元素值分别为:add_s,req_s,enpa_s,expa_s,分别用于表示接口文档查询信息对应的接口文档的所包括的接口分支功能的量化值。
需要说明的是,由于接口文档的接口分支功能在很多情况下都是字符串的形式体现,而字符串又很难来计算相互之间的相似度,考虑到这种情况,我们可以预先将所有的接口分支功能等信息进行归类,确定每个元素信息的字符串对应的数值代码,以通过数值代码来表示接口文档的各个元素信息的接口元素值,并能通过数值代码高效且精准的计算出接口文档库中的每个接口文档的接口元素值与接口文档查询信息的每个接口元素值之间的相似程度。
进一步的,由于很多情况下,所获取到的用户终端设备发送的接口文档查询信息都不是很完整,用户只是根据自己当前的需求输入一些关键字,也无法非常精确的通过用户输入的接口文档查询,来进行量化,得到非常完整的接口元素量化值。这种情况下,我们可以先确定接口文档查询信息中包含的接口元素值,并将接口文档查询信息中不包含的接口元素值补零,保证相似度计算的正确性和客观性。
S2022:根据所述接口文档查询信息中包含的接口功能对应的每个接口元素的接口元素值、所述接口文档库中预存的每个接口文档的每个接口元素的接口元素值,计算所述接口文档查询信息和所述接口文档库中预存的每个接口文档针对于每个接口元素对应的相似度。
本方案中的接口文档库中预存有每个接口文档的接口元素值,在对接口文档查询信息进行量化,确定接口文档查询信息中的接口元素值之后,通过计算接口文档库中每个接口文档的接口元素值与接口文档查询信息中的接口元素值,来确定两者之间针对于每个接口元素的相似度况。
具体的,接口文档库中的每个接口文档量化之后的接口元素值分别为:add_d,req_d,enpa_d,expa_d;接口文档查询信息确定用户所需要的接口文档量化之后的接口元素值分别为:add_s,req_s,enpa_s,expa_s,我们根据量化之后的接口元素值计算接口文档库中每个接口文档的接口元素值与接口文档查询信息中的接口元素值,分别针对于各个接口元素的相似度为:
其中,sim1、sim2、sim3以及sim4分别用于表示接口文档查询信息和接口文档库中预存的每个接口文档分别对应与不同接口元素上相似度,每个接口元素用于表示不同的接口功能。
S2023:根据每个接口元素对应的相似度,确定所述每个所述接口元素对应的相似度最大时的接口文档库中的接口文档为所述接口功能对应的每个接口元素分别对应的基础接口文档,以及所述每个所述基础接口文档的文档标识。
在计算所述接口文档查询信息和所述接口文档库中预存的每个接口文档针对于每个接口元素对应的相似度之后,根据每个接口元素对应的相似度,确定每个接口元素对应的相似度最大时的接口文档,为当前接口元素对应的基础接口文档,由此,我们便可以得到与接口元素的数目相同的基础接口文档数目,以及文档标识的数目。
可选的,还可以预设一个相似度阈值,通过该相似度阈值来确定大于或者等于该相似度阈值的接口文档为基础接口文档,此处不做限定。
需要说明的是,在实际应用中存在很多具有相似功能的接口,在我们进行相似度匹配的时候,可能存在多个功能相似或者相近的接口,为了防止查找到的接口文档数量过多,造成之后组装接口文档不精简的问题,我们这里可以预先设置一个数量,用于限制基础接口文档的数量,保证基础文档的数量最少的情况下,可以最大化的实现接口文档查询信息中的接口功能。进一步的,我们还可以为每个基础元素确定预设数量的基础接口文档,这些基础接口文档都是按照相似度由高到低排序所选择的前预设数量的接口文档,之后,对每个基础元素对应的多个基础接口文档进行数据融合和去重,得到该接口元素对应的功能最完备的、唯一的基础接口文档。
进一步的,也是因为存在很多功能相似或者相近的接口,虽然每个接口文档的功能相近,但不同的接口在数据处理的效率、入参或者出参的数据要求上也会有一定的差异,这种情况下,我们可以根据不同的接口文档来生成不同的接口组合,并确定每个接口组合中的文档标识,每个接口组合中的接口文档都可以完整实现接口功能。但是由于接口组合中接口文档的差异,不同的接口组合在进行数据处理时可能在效率、安全性以及出入参数据要求上有不同的效果,这种情况下,还可以根据开发人员的需求,设置接口组合计算效率、安全系数等衡量标准,来量化不同的运行效果,选取开发人员最需要的接口组合进行数据处理。
S203:根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档。
在确定了基础接口文档之后,根据基础接口文档的文档标识,从接口文档库中下载基础接口文档,并生成一个空白接口文档,这个空白接口文档中包括每个文档元素对应的文档格式,根据每个基础接口文档,确定目标接口文档的每个文档元素对应的数据,根据空白接口文档中的文档格式,每个文档元素对应的数据写入空白接口文档中,得到目标接口文档。
进一步的,步骤S203中可以具体包括步骤S2031~S2034:
S2031:根据所述基础接口文档的文档标识,从所述接口文档库中提取出所有所述文档标识对应的基础接口文档。
本实施例中预设有接口文档库,用于存储各种类型的接口文档。并且,在接口文档库中,将每个接口文档按照文档标识进行存储,其存储方式可以是根据相关的功能或者相同的类型来存储。示例性地,在接口文档库中,我们可以按照获取数据、处理数据、发送数据的数据处理功能,来将不同的接口文档存储至接口文档库中,还可以根据不同接口文档的类型来进行存储,示例性地,接口文档按照数据处理方式的不同可以分为输入型或者输出型接口,我们将接口文档按照输入或者输出的类型来进行存储,通过这种方式,可以提高接口文档的管理、查找和调用效率。
S2032:根据每个所述基础接口文档,确定所述目标接口文档中的接口元素。
在确定了基础接口文档之后,我们得到的所有基础接口文档整合在一起,便可以得到具有完整功能的、与接口文档查询信息对应的接口文档。因此,我们需要根据基础接口文档中的接口元素,来确定目标接口文档中的接口元素。在本实施例中,接口元素用于表示每个接口的接口信息,例如出参、入参、数据处理流程等信息。
在本实施例中,接口文档库中的每个接口文档都有统一的文档格式,例如,在固定的文档位置处,有对应的文档信息或者接口信息,数据处理终端设备可以通过识别基础接口文档,便可以确定每个基础接口文档中的接口元素,基础接口文档中的接口元素便为目标接口文档中的接口元素。
进一步的,步骤S2032中可以具体包括:提取每个所述基础接口文档中的基础元素;根据所有所述基础文档的基础元素,将相同的基础元素识别为一个接口元素,将不同的基础元素识别为不同的接口元素。
具体的,我们进行文档整合过程中,由于不同的基础接口文档中可能包括相同或者不同的基础元素,其中,相同的基础元素可以包括具有相同信息的接口元素,不同的基础元素用于表示同一接口元素在不同的基础接口文档中是关联、矛盾或者冲突的情况。对此,针对与重合的数据,只需要保留一份数据即可;对于关联的数据,需要在新生成的目标接口文档中说明关联的数据信息,对于矛盾或者冲突的数据,可以将所有数据都写入接口文档中,并通过统一的格式关联标明矛盾的地方,以通过人为的判断和修改来确定最终的接口文档。
S2033:生成一个空白接口文档;所述空白接口文档中包括每个所述接口元素对应的文档格式。
在确定了基础接口文档之后,根据基础接口文档的文档标识,生成一个空白接口文档,这个空白接口文档中包括每个文档元素对应的文档格式,根据每个基础接口文档,确定目标接口文档的每个文档元素对应的数据,根据空白接口文档中的文档格式,每个文档元素对应的数据写入空白接口文档中,得到目标接口文档。
S2034:根据所述空白接口文档中的文档格式,将所述目标接口文档的接口元素写入所述空白接口文档中,得到所述目标接口文档。
在生成空白接口文档之后,我们根据空包接口文档中的文档格式,将确定出来的目标接口文档的接口元素写入该空白接口文档中,得到目标接口文档。
进一步的,由于各个基础接口文档中可能存在重合或者冲突的接口元素,这种情况下,我们将重合的接口元素只在目标接口文档中体现一次,而将全部的、冲突的接口元素写入空白接口文档中对应的位置,以保证目标接口文档的完整性和正确性。并且,为了避免接口元素的冗余,可以在形成目标接口文档之后,获取用户终端设备发送的目标接口文档调整信息来进行修改或者调整,以保证目标接口文档的精简。
S204:对所述目标接口文档进行测试。
本方案中所生成的目标接口文档是通过将多个基础接口文档进行整合得到,为此,可能存在一些格式、逻辑上的问题,因此,本方案中得到目标接口文档只是将用户所需的多个接口整合在一起,方便用户查看或者调用,具体的正确性还需要通过在生成该目标接口文档之后通过用户测试,根据测试结果对目标接口文档进行修改和维护。
S205:若所述目标接口文档测试通过,则发送所述目标接口文档至所述用户终端设备。
在对所述目标接口文档进行测试之后,若测试通过,则表示我们整合得到的目标接口文档符合用户终端设备发送的接口文档查询信息,便可以将目标接口文档发送至用户终端设备。
可选的,还可以在得到最终的接口文档之后,还可以将其存储至接口文档库中,以便于对之后的接口文档进行补充和组合。
上述方案,通过获取用户终端设备发送的接口文档查询信息;当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;对所述目标接口文档进行测试;若所述目标接口文档测试通过,则发送所述目标接口文档至所述用户终端设备。当预设的接口文档库中不存在接口文档查询信息中接口功能对应的接口文档时,根据用户终端发送的接口文档查询信息中的接口功能,确定与接口功能对应的所有基础接口文档,并将其整合为一个接口文档,在测试之后以供调用,不仅简化了接口开发的流程、接口管理和接口调用的过程,也提高了接口开发的效率。
参见图3,图3是本发明实施例三提供的一种终端设备的示意图。终端设备包括的各单元用于执行图1~图2对应的实施例中的各步骤。具体请参阅图1~图2各自对应的实施例中的相关描述。为了便于说明,仅示出了与本实施例相关的部分。本实施例的终端设备300包括:
获取单元301,用于获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能;
查询单元302,用于当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;
整合单元303,用于根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;
发送单元304,用于发送所述目标接口文档至所述用户终端设备。
进一步的,所述查询单元302可以包括:
量化单元,用于对所述接口文档查询信息进行量化,确定所述接口文档查询信息中的接口元素值;所述接口元素值用于表示接口文档中各个接口元素的信息;所述接口元素用于表示所述接口文档的组成部分;
计算单元,用于根据所述接口元素值、所述接口文档库中预存的每个接口文档的接口元素值,计算两者之间的相似度;
识别单元,用于根据所述相似度,确定由至少两个基础接口文档组成的接口组合,以及每个所述接口组合中的基础接口文档的文档标识;所述接口组合中的全部基础接口文档用于共同实现所述接口功能。
进一步的,所述整合单元303可以包括:
提取单元,用于根据所述基础接口文档的文档标识,从所述接口文档库中提取出所有所述文档标识对应的基础接口文档;
确定单元,用于根据每个所述基础接口文档,确定所述目标接口文档中的接口元素;
生成单元,用于生成一个空白接口文档;所述空白接口文档中包括每个所述接口元素对应的文档格式;
写入单元,用于根据所述空白接口文档中的文档格式,将所述目标接口文档的接口元素写入所述空白接口文档中,得到所述目标接口文档。
进一步的,所述确定单元可以包括:
基础元素提取单元,用于提取每个所述基础接口文档中的基础元素;
元素分类识别单元,用于根据所有所述基础文档的基础元素,将相同的基础元素识别为一个接口元素,将不同的基础元素识别为不同的接口元素。
进一步的,所述发送单元304可以包括:
文档测试单元,用于对所述目标接口文档进行测试;
文档发送单元,用于若所述目标接口文档测试通过,则发送所述目标接口文档至所述用户终端设备。
上述方案,通过获取用户终端设备发送的接口文档查询信息;当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;对所述目标接口文档进行测试;若所述目标接口文档测试通过,则发送所述目标接口文档至所述用户终端设备。通过当预设的接口文档库中不存在接口文档查询信息中接口功能对应的接口文档时,根据用户终端发送的接口文档查询信息中的接口功能,将其整合为一个接口文档,并在测试之后以供调用,不仅简化了接口开发的流程、接口管理和接口调用的过程,也提高了接口开发的效率。
图4是本发明实施例四提供的终端设备的示意图。如图4所示,该实施例的终端设备4包括:处理器40、存储器41以及存储在所述存储器41中并可在所述处理器40上运行的计算机程序42。所述处理器40执行所述计算机程序42时实现上述各个接口文档生成方法实施例中的步骤,例如图1所示的步骤101至104。或者,所述处理器40执行所述计算机程序42时实现上述各装置实施例中各模块/单元的功能,例如图3所示单元301至304的功能。
示例性的,所述计算机程序42可以被分割成一个或多个模块/单元,所述一个或者多个模块/单元被存储在所述存储器41中,并由所述处理器40执行,以完成本发明。所述一个或多个模块/单元可以是能够完成特定功能的一系列计算机程序指令段,该指令段用于描述所述计算机程序42在所述终端设备4中的执行过程。
所述终端设备4可以是桌上型计算机、笔记本、掌上电脑及云端服务器等计算设备。所述终端设备可包括,但不仅限于,处理器40、存储器41。本领域技术人员可以理解,图4仅仅是终端设备4的示例,并不构成对终端设备4的限定,可以包括比图示更多或更少的部件,或者组合某些部件,或者不同的部件,例如所述终端设备还可以包括输入输出设备、网络接入设备、总线等。
所称处理器40可以是中央处理单元(Central Processing Unit,CPU),还可以是其他通用处理器、数字信号处理器(Digital Signal Processor,DSP)、专用集成电路(Application Specific Integrated Circuit,ASIC)、现成可编程门阵列(Field-Programmable Gate Array,FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件等。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等。
所述存储器41可以是所述终端设备4的内部存储单元,例如终端设备4的硬盘或内存。所述存储器41也可以是所述终端设备4的外部存储设备,例如所述终端设备4上配备的插接式硬盘,智能存储卡(Smart Media Card,SMC),安全数字(Secure Digital,SD)卡,闪存卡(Flash Card,FC)等。进一步地,所述存储器41还可以既包括所述终端设备4的内部存储单元也包括外部存储设备。所述存储器41用于存储所述计算机程序以及所述终端设备所需的其他程序和数据。所述存储器41还可以用于暂时地存储已经输出或者将要输出的数据。
所属领域的技术人员可以清楚地了解到,为了描述的方便和简洁,仅以上述各功能单元、模块的划分进行举例说明,实际应用中,可以根据需要而将上述功能分配由不同的功能单元、模块完成,即将所述装置的内部结构划分成不同的功能单元或模块,以完成以上描述的全部或者部分功能。实施例中的各功能单元、模块可以集成在一个处理单元中,也可以是各个单元单独物理存在,也可以两个或两个以上单元集成在一个单元中,上述集成的单元既可以采用硬件的形式实现,也可以采用软件功能单元的形式实现。另外,各功能单元、模块的具体名称也只是为了便于相互区分,并不用于限制本申请的保护范围。上述系统中单元、模块的具体工作过程,可以参考前述方法实施例中的对应过程,在此不再赘述。
在上述实施例中,对各个实施例的描述都各有侧重,某个实施例中没有详述或记载的部分,可以参见其它实施例的相关描述。
所述作为分离部件说明的单元可以是或者也可以不是物理上分开的,作为单元显示的部件可以是或者也可以不是物理单元,即可以位于一个地方,或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。
所述集成的模块/单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时,可以存储在一个计算机可读取存储介质中。基于这样的理解,本发明实现上述实施例方法中的全部或部分流程,也可以通过计算机程序来指令相关的硬件来完成,所述的计算机程序可存储于一计算机可读存储介质中。
以上所述实施例仅用以说明本发明的技术方案,而非对其限制;尽管参照前述实施例对本发明进行了详细的说明,本领域的普通技术人员应当理解:其依然可以对前述各实施例所记载的技术方案进行修改,或者对其中部分技术特征进行等同替换;而这些修改或者替换,并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围,均应包含在本发明的保护范围之内。
Claims (10)
1.一种接口文档生成方法,其特征在于,包括:
获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能;
当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;
根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;
发送所述目标接口文档至所述用户终端设备。
2.如权利要求1所述的接口文档生成方法,其特征在于,所述当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识,包括:
当预设的接口文档库中不存在所述接口功能对应的接口文档时,对所述接口文档查询信息进行量化,确定所述接口文档查询信息中的接口元素值;所述接口元素值用于表示接口文档中各个接口元素的信息;所述接口元素用于表示所述接口文档的组成部分;
根据所述接口文档查询信息中包含的接口功能对应的每个接口元素的接口元素值、所述接口文档库中预存的每个接口文档的每个接口元素的接口元素值,计算所述接口文档查询信息和所述接口文档库中预存的每个接口文档针对于每个接口元素对应的相似度;
根据每个接口元素对应的相似度,确定所述每个所述接口元素对应的相似度最大时的接口文档库中的接口文档为所述接口功能对应的每个接口元素分别对应的基础接口文档,以及所述每个所述基础接口文档的文档标识。
3.如权利要求1所述的接口文档生成方法,其特征在于,所述根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档,包括:
根据所述基础接口文档的文档标识,从所述接口文档库中提取出所有所述文档标识对应的基础接口文档;
根据每个所述基础接口文档,确定所述目标接口文档中的接口元素;
生成一个空白接口文档;所述空白接口文档中包括每个所述接口元素对应的文档格式;
根据所述空白接口文档中的文档格式,将所述目标接口文档的接口元素写入所述空白接口文档中,得到所述目标接口文档。
4.如权利要求3所述的接口文档生成方法,其特征在于,所述根据每个所述基础接口文档,确定所述目标接口文档的接口元素,包括:
提取每个所述基础接口文档中的基础元素;
根据所有所述基础文档的基础元素,将相同的基础元素识别为一个接口元素,将不同的基础元素识别为不同的接口元素。
5.如权利要求1-4任一项所述的接口文档生成方法,其特征在于,所述发送所述目标接口文档至所述用户终端设备,包括:
对所述目标接口文档进行测试;
若所述目标接口文档测试通过,则发送所述目标接口文档至所述用户终端设备。
6.一种终端设备,其特征在于,包括存储器以及处理器,所述存储器中存储有可在所述处理器上运行的计算机程序,其特征在于,所述处理器执行所述计算机程序时,实现如下步骤:
获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能;
当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;
根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;
发送所述目标接口文档至所述用户终端设备。
7.如权利要求6所述的终端设备,其特征在于,所述当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识,包括:
当预设的接口文档库中不存在所述接口功能对应的接口文档时,对所述接口文档查询信息进行量化,确定所述接口文档查询信息中的接口元素值;所述接口元素值用于表示接口文档中各个接口元素的信息;所述接口元素用于表示所述接口文档的组成部分;
根据所述接口文档查询信息中包含的接口功能对应的每个接口元素的接口元素值、所述接口文档库中预存的每个接口文档的每个接口元素的接口元素值,计算所述接口文档查询信息和所述接口文档库中预存的每个接口文档针对于每个接口元素对应的相似度;
根据每个接口元素对应的相似度,确定所述每个所述接口元素对应的相似度最大时的接口文档库中的接口文档为所述接口功能对应的每个接口元素分别对应的基础接口文档,以及所述每个所述基础接口文档的文档标识。
8.如权利要求6所述的终端设备,其特征在于,所述根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档,包括:
根据所述基础接口文档的文档标识,从所述接口文档库中提取出所有所述文档标识对应的基础接口文档;
根据每个所述基础接口文档,确定所述目标接口文档中的接口元素;
生成一个空白接口文档;所述空白接口文档中包括每个所述接口元素对应的文档格式;
根据所述空白接口文档中的文档格式,将所述目标接口文档的接口元素写入所述空白接口文档中,得到所述目标接口文档。
9.一种终端设备,其特征在于,包括:
获取单元,用于获取用户终端设备发送的接口文档查询信息;所述接口文档查询信息包括接口文档的接口功能;
查询单元,用于当预设的接口文档库中不存在所述接口功能对应的接口文档时,则在所述接口文档库中查找与所述接口功能对应的基础接口文档的文档标识;所述文档标识用于表示能够实现部分所述接口功能的基础接口文档的标识;所述基础接口文档是通过将所述接口功能对应的接口元素和所述接口文档库中的每个接口文档的接口元素进行匹配后得到的最优接口文档;
整合单元,用于根据所述基础接口文档的文档标识,对所述基础接口文档进行整合得到目标接口文档;
发送单元,用于发送所述目标接口文档至所述用户终端设备。
10.一种计算机可读存储介质,所述计算机可读存储介质存储有计算机程序,其特征在于,所述计算机程序被处理器执行时实现如权利要求1至5任一项所述方法的步骤。
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN201910429578.1A CN110244945A (zh) | 2019-05-22 | 2019-05-22 | 接口文档生成方法及终端设备 |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN201910429578.1A CN110244945A (zh) | 2019-05-22 | 2019-05-22 | 接口文档生成方法及终端设备 |
Publications (1)
Publication Number | Publication Date |
---|---|
CN110244945A true CN110244945A (zh) | 2019-09-17 |
Family
ID=67884779
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
CN201910429578.1A Pending CN110244945A (zh) | 2019-05-22 | 2019-05-22 | 接口文档生成方法及终端设备 |
Country Status (1)
Country | Link |
---|---|
CN (1) | CN110244945A (zh) |
Cited By (4)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN111949253A (zh) * | 2020-08-07 | 2020-11-17 | 北京字节跳动网络技术有限公司 | 组合idl文件的方法、装置、计算机设备和存储介质 |
CN112068813A (zh) * | 2020-09-03 | 2020-12-11 | 中国平安财产保险股份有限公司 | 数据处理方法、设备及介质 |
CN113031925A (zh) * | 2021-03-25 | 2021-06-25 | 重庆中科云从科技有限公司 | 一种接口文档生成方法、装置、机器可读介质及设备 |
CN117472367A (zh) * | 2023-12-27 | 2024-01-30 | 中电数据产业有限公司 | 异构资源智能识别及接入方法、装置、设备以及存储介质 |
-
2019
- 2019-05-22 CN CN201910429578.1A patent/CN110244945A/zh active Pending
Cited By (6)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN111949253A (zh) * | 2020-08-07 | 2020-11-17 | 北京字节跳动网络技术有限公司 | 组合idl文件的方法、装置、计算机设备和存储介质 |
CN111949253B (zh) * | 2020-08-07 | 2023-12-01 | 抖音视界有限公司 | 组合idl文件的方法、装置、计算机设备和存储介质 |
CN112068813A (zh) * | 2020-09-03 | 2020-12-11 | 中国平安财产保险股份有限公司 | 数据处理方法、设备及介质 |
CN113031925A (zh) * | 2021-03-25 | 2021-06-25 | 重庆中科云从科技有限公司 | 一种接口文档生成方法、装置、机器可读介质及设备 |
CN117472367A (zh) * | 2023-12-27 | 2024-01-30 | 中电数据产业有限公司 | 异构资源智能识别及接入方法、装置、设备以及存储介质 |
CN117472367B (zh) * | 2023-12-27 | 2024-03-26 | 中电数据产业有限公司 | 异构资源智能识别及接入方法、装置、设备以及存储介质 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
CN110244945A (zh) | 接口文档生成方法及终端设备 | |
JP6754495B2 (ja) | ブロックチェーンを介したアイデンティティと証明書の保護及び検証とのための方法及びシステム | |
US9582594B2 (en) | Method and system for centralized issue tracking | |
EP1909196B1 (en) | Discovery of services matching a service request | |
CN108846753A (zh) | 用于处理数据的方法和装置 | |
CN111427971B (zh) | 用于计算机系统的业务建模方法、装置、系统和介质 | |
EP3470992B1 (en) | Efficient storage and utilization of a hierarchical data set | |
CN111046237A (zh) | 用户行为数据处理方法、装置、电子设备及可读介质 | |
US20230116336A1 (en) | API Governance Enforcement Architecture | |
CN111984745B (zh) | 数据库字段动态扩展方法、装置、设备及存储介质 | |
CN109542657A (zh) | 系统异常的处理方法及服务器 | |
CN112433753A (zh) | 基于参数信息的接口文档生成方法、装置、设备和介质 | |
CN111488386A (zh) | 数据查询方法和装置 | |
CN115620886A (zh) | 一种数据审核方法和装置 | |
CN109710634A (zh) | 用于生成信息的方法及装置 | |
CN109086438A (zh) | 用于查询信息的方法和装置 | |
CN109542890A (zh) | 数据修改方法、装置、计算机设备及存储介质 | |
CN115292516A (zh) | 基于区块链的分布式知识图谱构建方法、装置及系统 | |
Du et al. | Multi-strategy web service discovery for smart government | |
US10394761B1 (en) | Systems and methods for analyzing and storing network relationships | |
US7904431B1 (en) | Method and system for automated request modelling | |
CN113468258A (zh) | 一种异构数据的转换方法、装置及存储介质 | |
CN114282002A (zh) | 基于人工智能的知识生成方法、装置、设备及存储介质 | |
CN104572649B (zh) | 分布式存储系统的数据的处理方法、装置及系统 | |
CN110489414A (zh) | 报表推送方法及设备 |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
PB01 | Publication | ||
PB01 | Publication | ||
SE01 | Entry into force of request for substantive examination | ||
SE01 | Entry into force of request for substantive examination |