CN118245140A - 接口调用示例生成方法和装置、电子设备和存储介质 - Google Patents

Abstract

本申请提供了一种接口调用示例生成方法和装置、电子设备和存储介质，其中，该方法包括：获取指定接口的指定接口参数信息，其中，所述指定接口为需要生成接口调用示例的接口；通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，所述候选示例模板是调用方系统采用候选软件语言编写时的示例模板，所述候选接口调用示例为采用所述候选软件语言编写的调用方系统对所述指定接口进行调用的代码示例。通过本申请，解决了相关技术中存在的人工编写与每个软件语言对应的接口调用示例，导致效率低下，并且会影响后续调用方系统通过调用接口接入请求方系统的时间的问题。

Description

接口调用示例生成方法和装置、电子设备和存储介质

技术领域

本申请涉及接口调用技术领域，尤其涉及一种接口调用示例生成方法和装置、电子设备和存储介质。

背景技术

在现有技术中，不同的两个系统或两个业务之间经常需要进行数据交互。并且，两个系统、两个业务之间的数据交互，需要通过接口来支持。由于，各个系统可能是采用不同的软件语言开发的，因此，为了接入方便，需要写接口调用示例指导调用方系统的开发人员开发调用接口的程序。并且在接入被请求方系统的调用方系统越多的情况下，调用方系统所使用的软件语言就往往越多，因此，接口调用示例就得写多种软件语言(每种软件语言都需要有对应的示例)。

在相关技术中，是通过提供接口的开发人员人工编写与每个软件语言对应的接口调用示例，效率低下，并且会影响后续调用方系统通过调用接口接入请求方系统的时间。

由此可见，相关技术中存在人工编写与每个软件语言对应的接口调用示例，导致效率低下，并且会影响后续调用方系统通过调用接口接入请求方系统的时间的问题。

发明内容

本申请提供了一种接口调用示例生成方法和装置、电子设备和存储介质，以至少解决相关技术中存在人工写出与每个软件语言对应的接口调用示例导致效率低下，并且会影响后续调用方系统通过调用接口接入请求方系统的时间的问题。

根据本申请实施例的一个方面，提供了一种接口调用示例生成方法，包括：

获取指定接口的指定接口参数信息，其中，所述指定接口为需要生成接口调用示例的接口；

通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，所述候选示例模板是调用方系统采用候选软件语言编写时的示例模板，所述候选接口调用示例为采用所述候选软件语言编写的调用方系统对所述指定接口进行调用的代码示例。

可选地，如前述的方法，所述通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，包括：

确定出所述指定接口参数信息中的所有指定接口参数；

确定出所述候选示例模板中的每个候选模板变量与每个指定接口参数之间的一一对应关系；

按照所述一一对应关系，通过所述每个指定接口参数对所述每个候选模板变量进行赋值，得到所述候选接口调用示例。

可选地，如前述的方法，在所述通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例之后，所述方法还包括：

获取第一接口调用方系统使用的第一软件语言以及所要调用的第一接口；

在所述第一接口为所述指定接口的情况下，按照所述第一软件语言，在所有所述候选接口调用示例中查询出第一接口调用示例，其中，所述第一接口调用示例对应的调用方系统所使用的软件语言为所述第一软件语言，所述第一接口调用示例对应的被调用接口为所述指定接口。

可选地，如前述的方法，在所述获取指定接口的指定接口参数信息之后，所述方法还包括：

获取第二接口调用方系统使用的第二软件语言以及所要使用的第二接口；

在所有候选示例模板中确定出所述第二软件语言对应的第二示例模板；在所述第二接口为所述指定接口的情况下，在所有预设的接口参数信息中，确定出所述指定接口对应的指定接口参数信息；

通过所述指定接口参数信息对所述第二示例模板进行渲染，得到第二接口调用示例。

可选地，如前述的方法，在所述通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例之后，所述方法还包括：

对所述候选接口调用示例进行校验，并得到校验结果；

在所述校验结果指示所述候选接口调用示例能正确调用所述指定接口的情况下，将所述候选接口调用示例进行存储。

可选地，如前述的方法，在所述对所述候选接口调用示例进行校验，并得到校验结果之后，所述方法还包括：

在所述校验结果指示所述候选接口调用示例不能正确调用所述指定接口的情况下，生成用于指示所述候选接口调用示例错误的错误信息；

按照所述错误信息对所述候选接口调用示例进行删除，并进行报警。

可选地，如前述的方法，所述获取指定接口的指定接口参数信息，包括：

获取目标对象上传的指定接口特征参数、指定请求参数以及指定返回参数，其中，所述指定接口特征参数为所述指定接口的访问地址，所述指定返回参数为入参为所述指定请求参数时返回的参数。

根据本申请实施例的另一个方面，还提供了一种接口调用示例生成装置，包括：

获取模块，用于获取指定接口的指定接口参数信息，其中，所述指定接口为需要生成接口调用示例的接口；

渲染模块，用于通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，所述候选示例模板是调用方系统采用候选软件语言编写时的示例模板，所述候选接口调用示例为采用所述候选软件语言编写的调用方系统对所述指定接口进行调用的代码示例。

根据本申请实施例的又一个方面，还提供了一种电子设备，包括处理器、通信接口、存储器和通信总线，其中，处理器、通信接口和存储器通过通信总线完成相互间的通信；其中，存储器，用于存储计算机程序；处理器，用于通过运行所述存储器上所存储的所述计算机程序来执行上述任一实施例中的方法步骤。

根据本申请实施例的又一个方面，还提供了一种计算机可读的存储介质，该存储介质中存储有计算机程序，其中，该计算机程序被设置为运行时执行上述任一实施例中的方法步骤。

在本申请实施例中，采用获取指定接口的指定接口参数信息，其中，所述指定接口为需要生成接口调用示例的接口；通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，所述候选示例模板是调用方系统采用候选软件语言编写时的示例模板，所述候选接口调用示例为采用所述候选软件语言编写的调用方系统对所述指定接口进行调用的代码示例的方式。通过本实施例中的方法，只基于指定接口的指定接口参数信息，即可自动对候选软件语言对应的示例模板进行渲染，进而得到采用候选软件语言编写的调用方系统对指定接口进行调用的候选接口调用示例；从而无需人工编写与每个软件语言对应的接口调用示例，可以极大地提高接口调用示例的生成效率；因此可以克服相关技术中人工编写与每个软件语言对应的接口调用示例，导致效率低下，并且会影响后续调用方系统通过调用接口接入请求方系统的时间的问题。

附图说明

此处的附图被并入说明书中并构成本说明书的一部分，示出了符合本申请的实施例，并与说明书一起用于解释本申请的原理。

为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，对于本领域普通技术人员而言，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。

图1是根据本申请实施例的一种可选的接口调用示例生成方法的流程示意图；

图2是根据本申请另一实施例的一种可选的接口调用示例生成方法的流程示意图；

图3是根据本申请实施例的一种可选的接口调用示例生成装置的结构框图；

图4是根据本申请实施例的一种可选的电子设备的结构框图。

具体实施方式

为了使本技术领域的人员更好地理解本申请方案，下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本申请一部分的实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都应当属于本申请保护的范围。

需要说明的是，本申请的说明书和权利要求书及上述附图中的术语“第一”、“第二”等是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便这里描述的本申请的实施例能够以除了在这里图示或描述的那些以外的顺序实施。此外，术语“包括”和“具有”以及他们的任何变形，意图在于覆盖不排他的包含，例如，包含了一系列步骤或单元的过程、方法、系统、产品或设备不必限于清楚地列出的那些步骤或单元，而是可包括没有清楚地列出的或对于这些过程、方法、产品或设备固有的其它步骤或单元。

根据本申请实施例的一个方面，提供了一种接口调用示例生成方法。可选地，在本实施例中，上述接口调用示例生成方法可以应用于由终端和服务器所构成的硬件环境中。服务器通过网络与终端进行连接，可用于为终端或终端上安装的客户端提供服务(如广告推送服务、应用服务等)，可在服务器上或独立于服务器设置数据库，用于为服务器提供数据存储服务。

上述网络可以包括但不限于以下至少之一：有线网络，无线网络。上述有线网络可以包括但不限于以下至少之一：广域网，城域网，局域网，上述无线网络可以包括但不限于以下至少之一：WIFI(Wireless Fidelity，无线保真)，蓝牙。终端可以并不限定于为PC、手机、平板电脑等。

本申请实施例的接口调用示例生成方法可以由服务器来执行，也可以由终端来执行，还可以是由服务器和终端共同执行。其中，终端执行本申请实施例的接口调用示例生成方法也可以是由安装在其上的客户端来执行。

以由服务器来执行本实施例中的接口调用示例生成方法为例，图1为本申请实施例提供的一种接口调用示例生成方法，包括如下所述步骤：

步骤S101，获取指定接口的指定接口参数信息，其中，指定接口为需要生成接口调用示例的接口。

本实施例中的接口调用示例生成方法可以应用于需要在自动生成与指定接口以及接口调用系统的编程语言对应的场景，例如：生成采用Java语言编写的接口调用系统对指定接口进行调用的调用示例的场景、生成采用C++语言编写的接口调用系统对指定接口进行调用的调用示例的场景等，也可以是生成采用其他编程语言编写的接口调用系统对指定接口进行调用的调用示例的场景。本申请实施例中生成采用Java语言编写的接口调用系统对指定接口进行调用的调用示例说明上述的接口调用示例生成方法，对于其他类型的软件语言，在不矛盾的情况下，上述的接口调用示例生成方法同样适用。

为了生成与指定接口对应的候选接口调用示例，因此，需要获取与指定接口对应的指定接口参数信息。

本实施例中的获取指定接口的指定接口参数信息，可以是获取目标对象上传的指定接口特征参数、指定请求参数以及指定返回参数。指定接口特征参数可以是指定接口的接口名称或者指定接口的接口地址等能够唯一指示该指定接口的信息。

指定接口特征参数为指定接口的访问地址，指定返回参数为入参为指定请求参数时返回的参数。

目标对象可以是开发指定接口或维护该指定接口的相关人员、或者相关人员操作的终端。

步骤S102，通过指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，候选示例模板是调用方系统采用候选软件语言编写时的示例模板，候选接口调用示例为采用候选软件语言编写的调用方系统对指定接口进行调用的代码示例。

在获取指定接口参数信息之后，即可通过该指定接口参数信息，对调用方系统采用候选软件语言编写时的候选示例模板进行渲染，以得到候选接口调用示例。

每个候选软件语言都具有对应的候选示例模板。以便于调用方系统对应的开发人员可以看懂通过所对应的候选示例模板渲染得到的候选接口调用示例。每个候选软件语言可以对应有多个候选示例模板，包括但不限于：接口调用模板、请求参数模板、返回数据模版。

当多个接口调用方系统采用不同的软件语言编写时，只要调用的是同一个指定接口，则对不同的候选示例模板进行渲染的指定接口参数信息都相同。但最终渲染得到的候选接口调用示例则是与每个调用方系统所采用的软件语言对应的。

可选地，通过指定接口参数信息对候选示例模板进行渲染可以是在候选示例模板中确定出与指定接口参数信息中每个参数对应的写入位置，然后将指定接口参数信息写入候选示例模板之后，即可得到候选接口调用示例。

候选软件语言可以是任意一种软件语言，指定接口可以是任一个接口，进而本实施例中的方法可以应用于生成与任意一个接口对应的，在任意一种软件语言下的接口调用示例。

例如，调用方系统采用Java语言编写时，则调用方系统的开发人员一般能够看懂Java语言的候选接口调用示例，因此采用指定接口参数信息对Java语言的候选示例模板进行渲染，以得到Java语言下的对指定接口进行调用的候选接口调用示例。

通过本实施例中的方法，可以只基于指定接口的指定接口参数信息，即可自动对候选软件语言对应的示例模板进行渲染，进而得到采用候选软件语言编写的调用方系统对指定接口进行调用的候选接口调用示例；从而无需人工编写与每个软件语言对应的接口调用示例，可以极大地提高接口调用示例的生成效率；因此可以克服相关技术中人工编写与每个软件语言对应的接口调用示例，导致效率低下，并且会影响后续调用方系统通过调用接口接入请求方系统的时间的问题。

如图2所示，作为一种可选的实施例，如前述的方法，所述步骤S102通过指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，包括如下所述步骤：

步骤S201，确定出指定接口参数信息中的所有指定接口参数。

在获取指定接口参数信息之后，可以对指定接口参数信息进行解析，以得到指定接口参数信息中的所有指定接口参数。

指定接口参数可以是前述实施例中的指定接口特征参数、指定请求参数以及指定返回参数，并且每个指定请求参数都存在对应的指定返回参数。

步骤S202，确定出候选示例模板中的每个候选模板变量与每个指定接口参数之间的一一对应关系。

为了确定出通过每个指定接口参数对候选示例模板进行渲染的规则，可以在候选示例模板中预先设定多个候选模板变量，然后确定每个候选模板变量所对应的指定接口参数。

可选地，可以在指定接口参数信息中先设定与每个指定接口参数对应的预设模板变量，可以采用数据表的形式得到指定接口参数与预设模板变量之间的第一对应关系；也可以采用key-value，并通过将预设模板变量作为键名，将指定接口参数作为键名的方式，得到指定接口参数与预设模板变量之间的第一对应关系。然后确定出与每个预设模板变量相同的候选模板变量并得到第二对应关系，进而可以基于第一对应关系以及第二对应关系得到候选模板变量与每个指定接口参数之间的一一对应关系。

例如，采用{$api['action']}作为接口名称对应的候选模板变量。

此外，还可以采用如下所示变量作为请求参数的候选模板变量：

foreach$api['params']$param}

/**{$param['param_desc']}*/

{if$param['param_type']！＝'Array'}

@KsYunField(name＝"{$param['param_name']}")

{/if}

{if$param['param_type']＝＝'Array'}

@KsYunField(name＝"{$param['param_name']},type＝2")

{if$param['data_type']＝＝'Int'}

步骤S203，按照一一对应关系，通过每个指定接口参数对每个候选模板变量进行赋值，得到候选接口调用示例。

在得到一一对应关系之后，即可通过每个指定接口参数对每个候选模板变量进行赋值，得到候选接口调用示例。

例如，以采用{$api['action']}作为接口名称对应的候选模板变量为例，可以采用将指定接口参数对{$api['action']}进行替换的方式，达到对候选模板变量{$api['action']}进行赋值的目的。

进而，在对每个候选模板变量都进行赋值之后，即可得到候选接口调用示例。

通过本实施例中的方法，提供了一种可以自动基于几口参数信息对示例模板进行渲染的实现方式，进而可以有效提升生成接口效用示例的效率。

作为一种可选的实施例，如前述的方法，在所述步骤S102通过指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例之后，方法还包括如下所述步骤：

步骤S301，获取第一接口调用方系统使用的第一软件语言以及所要调用的第一接口。

步骤S302，在第一接口为指定接口的情况下，按照第一软件语言，在所有候选接口调用示例中查询出第一接口调用示例，其中，第一接口调用示例对应的调用方系统所使用的软件语言为第一软件语言，第一接口调用示例对应的被调用接口为指定接口。

在得到候选接口调用示例之后，当第一接口调用方系统的用户进入接口示例页，并通过在接口示例页中进行软件语言的选择，以及接口的选择，进而可以获取第一接口调用方系统使用的第一软件语言以及所要调用的第一接口。

可选地，第一接口可以是通过第一接口的接口名称进行指示的。

在确定出第一软件语言以及所要调用的第一接口之后，即可在存储有接口调用示例的数据库中进行所需的接口调用示例的查询。

在确定第一接口为指定接口的情况下，则可以按照第一软件语言，在于第一接口对应的所有候选接口调用示例中查询出第一接口调用示例。

例如：可以先根据指定接口的接口名称，在数据库中查询到与指定接口对应的所有候选接口调用示例，所有候选接口调用示例中可以包括指定接口与每种软件语言对应的每个候选接口调用示例。然后按照每个候选接口调用示例所对应的软件语言，以及所述第一软件语言，在所有候选接口调用示例中查询出所对应的软件语言为第一软件语言的第一接口调用示例。

通过本实施例中的方法，可以通过预先生成所有接口调用示例，进而在获取第一接口调用方系统对应的第一软件语言以及所要调用的第一接口之后，可以快速确定出与第一接口调用方系统对应的第一接口调用示例。

作为一种可选的实施例，可以在获取用户需求之后，再进行接口调用示例的实时生成。如前述的方法，在所述步骤S101获取指定接口的指定接口参数信息之后，方法还包括如下所述步骤：

步骤S401，获取第二接口调用方系统使用的第二软件语言以及所要使用的第二接口。

在得到指定接口的指定接口参数信息之后，并且指定接口可以是任一个接口。因此，当第二接口调用方系统的用户进入接口示例页，并通过在接口示例页中进行软件语言的选择，以及接口的选择，进而可以获取第二接口调用方系统使用的第二软件语言以及所要调用的第二接口。

步骤S402，在所有候选示例模板中确定出第二软件语言对应的第二示例模板；在第二接口为指定接口的情况下，在所有预设的接口参数信息中，确定出指定接口对应的指定接口参数信息。

在确定出第二软件语言之后，按照第二软件语言对应的第一语言标识，以及预设的每个候选示例模板对应的第二语言标识，在所有候选示例模板中确定出与第二语言标识与第一语言标识相同的候选示例模板，并将其作为第二示例模板。

在确定出第二接口之后，即可在存储有接口参数信息的参数信息数据库中进行所需的接口参数信息的查询。

参数信息数据库中可以一一对应地存储有接口参数信息与接口名称。

在确定第二接口为指定接口的情况下，在所有接口参数信息中确定出接口名称与指定接口的指定接口参数名称的相同的指定接口参数信息。

步骤S403，通过指定接口参数信息对第二示例模板进行渲染，得到第二接口调用示例。

在确定出指定接口参数信息以及第二示例模板之后，即可通过指定接口参数信息对第二示例模板进行渲染，得到第二接口调用示例。通过指定接口参数信息对第二示例模板进行渲染的实现方式可以参照前述实施例中渲染得到候选接口调用示例的实现方式，在此不再进行赘述。

通过本实施例中的方法，可以基于实时获取的第二接口调用方系统使用的第二软件语言以及所要使用的第二接口，实时生成对应的第二接口调用示例，进而可以有效降低数据库中对接口调用示例的存储压力。

作为一种可选的实施例，如前述的方法，在所述步骤S102通过指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例之后，方法还包括如下所述步骤：

步骤S501，对候选接口调用示例进行校验，并得到校验结果；

步骤S502，在校验结果指示候选接口调用示例能正确调用指定接口的情况下，将候选接口调用示例进行存储。

步骤S503，在校验结果指示候选接口调用示例不能正确调用指定接口的情况下，生成用于指示候选接口调用示例错误的错误信息；

步骤S504，按照错误信息对候选接口调用示例进行删除，并进行报警。

在得到候选接口调用示例之后，可以对候选接口调用示例进行校验，例如，通过候选接口调用示例中的接口地址能否成功调用到指定接口，将候选接口调用示例中的入参输入指定接口之后，返回的参数是否与候选接口调用示例中的入参对应的出参一致。进而得到对该候选接口调用示例进行校验的校验结果。

在校验结果指示候选接口调用示例能正确调用指定接口的情况下，将候选接口调用示例进行存储，并将其作为能够向用户提供正确调用方法的调用示例。

在校验结果指示候选接口调用示例不能正确调用指定接口的情况下，则可生成用于指示候选接口调用示例错误的错误信息；例如，通过候选接口调用示例中的接口地址不能成功调用到指定接口，将候选接口调用示例中的入参输入指定接口之后，返回的参数与候选接口调用示例中的入参对应的出参不一致等等。

错误信息中可以包括但不限于：候选接口调用示例的标识信息，以及错误的类型。

步骤S504，按照错误信息对候选接口调用示例进行删除，并进行报警。

在生成错误信息之后，即可基于该错误信息确定出候选接口调用示例存在错误，进而基于该错误信息对该接口调用示例进行删除，并进行报警。

可选地，可以将该报警的报警信息发送至上传与该候选接口调用示例对应的指定接口参数信息的账户，以使账户对应的人员可以重新上传正确的接口参数信息，并重新生成正确的接口调用示例。

通过本实施例中的方法，可以对候选接口调用示例进行验证，并在候选接口调用示例正确时才对其进行存储，以免用户被错误的候选接口调用示例影响，进而导致无法正确调用得到指定接口；并在候选接口调用示例错误的情况下进行报警，进而可以及时对错误的候选接口调用示例进行纠正，提升用户体验。

如下所述，提供一种应用前述任一实施例的应用例：

每个软件语言可以预先编写一套候选示例模版(每套候选示例模板可以包括：接口调用模板、请求参数模板、返回数据模版)，然后如果有新接口上线，新接口的开发人员只需要到接口示例页对应的平台配置新接口参数信息(包括但不限于：新接口的新接口地址、请求参数与返回参数)到数据里。点击发布，就可以通过该新接口参数信息渲染与每个软件语言对应的候选示例模板，以使各个候选示例模板解析到新接口参数信息中的接口地址、请求参数与返回参数，并生成与每个软件语言对应的新接口调用代码。进而，采用预先生成好各个软件语言与该新接口对应的新接口调用示例。从而，可以使用户在使用时候选择到软件语言的接口调用示例都是预先生成好的。

用户购买指定的产品服务后，进入接口示例页，选择需要使用的目标接口和目标软件语言，即可自动在接口示例页展示目标软件语言下的一个对目标接口进行接口调用的目标接口调用示例，进而用户侧的开发人员可以直接下载该目标接口调用示例以进行使用。

需要说明的是，对于前述的各方法实施例，为了简单描述，故将其都表述为一系列的动作组合，但是本领域技术人员应该知悉，本申请并不受所描述的动作顺序的限制，因为依据本申请，某些步骤可以采用其他顺序或者同时进行。其次，本领域技术人员也应该知悉，说明书中所描述的实施例均属于优选实施例，所涉及的动作和模块并不一定是本申请所必须的。

通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到根据上述实施例的方法可借助软件加必需的通用硬件平台的方式来实现，当然也可以通过硬件，但很多情况下前者是更佳的实施方式。基于这样的理解，本申请的技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质(如ROM(Read-Only Memory，只读存储器)/RAM(Random Access Memory，随机存取存储器)、磁碟、光盘)中，包括若干指令用以使得一台终端设备(可以是手机，计算机，服务器，或者网络设备等)执行本申请各个实施例所述的方法。

根据本申请实施例的另一个方面，还提供了一种用于实施上述接口调用示例生成方法的接口调用示例生成装置。图3是根据本申请实施例的一种可选的接口调用示例生成装置的结构框图，如图3所示，该装置可以包括：

获取模块1，用于获取指定接口的指定接口参数信息，其中，指定接口为需要生成接口调用示例的接口；

渲染模块2，用于通过指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，候选示例模板是调用方系统采用候选软件语言编写时的示例模板，候选接口调用示例为采用候选软件语言编写的调用方系统对指定接口进行调用的代码示例。

需要说明的是，该实施例中的获取模块1可以用于执行上述步骤S101，该实施例中的渲染模块2可以用于执行上述步骤S102。

通过上述模块，可以只基于指定接口的指定接口参数信息，即可自动对候选软件语言对应的示例模板进行渲染，进而得到采用候选软件语言编写的调用方系统对指定接口进行调用的候选接口调用示例；从而无需人工编写与每个软件语言对应的接口调用示例，可以极大地提高接口调用示例的生成效率；因此可以克服相关技术中人工编写与每个软件语言对应的接口调用示例，导致效率低下，并且会影响后续调用方系统通过调用接口接入请求方系统的时间的问题。

此处需要说明的是，上述模块与对应的步骤所实现的示例和应用场景相同，但不限于上述实施例所公开的内容。需要说明的是，上述模块作为装置的一部分可以运行在实现如图1所示方法的硬件环境中，可以通过软件实现，也可以通过硬件实现，其中，硬件环境包括网络环境。

根据本申请实施例的又一个方面，还提供了一种用于实施上述接口调用示例生成方法的电子设备，该电子设备可以是服务器、终端、或者其组合。

根据本申请的另一个实施例，还提供一种电子设备，包括：如图4所示，电子设备可以包括：处理器1501、通信接口1502、存储器1503和通信总线1504，其中，处理器1501，通信接口1502，存储器1503通过通信总线1504完成相互间的通信。

存储器1503，用于存放计算机程序；

处理器1501，用于执行存储器1503上所存放的程序时，实现如下步骤：

步骤S101，获取指定接口的指定接口参数信息，其中，指定接口为需要生成接口调用示例的接口。

步骤S102，通过指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，候选示例模板是调用方系统采用候选软件语言编写时的示例模板，候选接口调用示例为采用候选软件语言编写的调用方系统对指定接口进行调用的代码示例。

可选地，在本实施例中，上述的通信总线可以是PCI(Peripheral ComponentInterconnect，外设部件互连标准)总线、或EISA(Extended Industry StandardArchitecture，扩展工业标准结构)总线等。该通信总线可以分为地址总线、数据总线、控制总线等。为便于表示，图中仅用一条粗线表示，但并不表示仅有一根总线或一种类型的总线。通信接口用于上述电子设备与其他设备之间的通信。

存储器可以包括随机存取存储器(Random Access Memory，RAM)，也可以包括非易失性存储器(Non-Volatile Memory，NVM)，例如至少一个磁盘存储器。可选的，存储器还可以是至少一个位于远离前述处理器的存储装置。

上述处理器可以是通用处理器，可以包含但不限于：CPU(Central ProcessingUnit，中央处理器)、NP(Network Processor，网络处理器)等；还可以是DSP(DigitalSignal Processor，数字信号处理器)、ASIC(Application Specific IntegratedCircuit，专用集成电路)、FPGA(Field－Programmable Gate Array，现场可编程门阵列)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。

本申请实施例还提供一种计算机可读存储介质，存储介质包括存储的程序，其中，程序运行时执行上述方法实施例的方法步骤。

可选地，在本实施例中，上述存储介质可以包括但不限于：U盘、ROM、RAM、移动硬盘、磁碟或者光盘等各种可以存储程序代码的介质。

上述本申请实施例序号仅仅为了描述，不代表实施例的优劣。

上述实施例中的集成的单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在上述计算机可读取的存储介质中。基于这样的理解，本申请的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的全部或部分可以以软件产品的形式体现出来，该计算机软件产品存储在存储介质中，包括若干指令用以使得一台或多台计算机设备(可为个人计算机、服务器或者网络设备等)执行本申请各个实施例所述方法的全部或部分步骤。

在本申请的上述实施例中，对各个实施例的描述都各有侧重，某个实施例中没有详述的部分，可以参见其他实施例的相关描述。

在本申请所提供的几个实施例中，应该理解到，所揭露的客户端，可通过其它的方式实现。其中，以上所描述的装置实施例仅仅是示意性的，例如所述单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个系统，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些接口，单元或模块的间接耦合或通信连接，可以是电性或其它的形式。

所述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例中所提供的方案的目的。

另外，在本申请各个实施例中的各功能单元可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。上述集成的单元既可以采用硬件的形式实现，也可以采用软件功能单元的形式实现。

以上所述仅是本申请的优选实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本申请原理的前提下，还可以做出若干改进和润饰，这些改进和润饰也应视为本申请的保护范围。

Claims (10)

1.一种接口调用示例生成方法，其特征在于，包括：

获取指定接口的指定接口参数信息，其中，所述指定接口为需要生成接口调用示例的接口；

通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，所述候选示例模板是调用方系统采用候选软件语言编写时的示例模板，所述候选接口调用示例为采用所述候选软件语言编写的调用方系统对所述指定接口进行调用的代码示例。

2.根据权利要求1所述的方法，其特征在于，所述通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，包括：

确定出所述指定接口参数信息中的所有指定接口参数；

确定出所述候选示例模板中的每个候选模板变量与每个指定接口参数之间的一一对应关系；

按照所述一一对应关系，通过所述每个指定接口参数对所述每个候选模板变量进行赋值，得到所述候选接口调用示例。

3.根据权利要求1所述的方法，其特征在于，在所述通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例之后，所述方法还包括：

获取第一接口调用方系统使用的第一软件语言以及所要调用的第一接口；

在所述第一接口为所述指定接口的情况下，按照所述第一软件语言，在所有所述候选接口调用示例中查询出第一接口调用示例，其中，所述第一接口调用示例对应的调用方系统所使用的软件语言为所述第一软件语言，所述第一接口调用示例对应的被调用接口为所述指定接口。

4.根据权利要求1所述的方法，其特征在于，在所述获取指定接口的指定接口参数信息之后，所述方法还包括：

获取第二接口调用方系统使用的第二软件语言以及所要使用的第二接口；

在所有候选示例模板中确定出所述第二软件语言对应的第二示例模板；在所述第二接口为所述指定接口的情况下，在所有预设的接口参数信息中，确定出所述指定接口对应的指定接口参数信息；

通过所述指定接口参数信息对所述第二示例模板进行渲染，得到第二接口调用示例。

5.根据权利要求1所述的方法，其特征在于，在所述通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例之后，所述方法还包括：

对所述候选接口调用示例进行校验，并得到校验结果；

在所述校验结果指示所述候选接口调用示例能正确调用所述指定接口的情况下，将所述候选接口调用示例进行存储。

6.根据权利要求5所述的方法，其特征在于，在所述对所述候选接口调用示例进行校验，并得到校验结果之后，所述方法还包括：

在所述校验结果指示所述候选接口调用示例不能正确调用所述指定接口的情况下，生成用于指示所述候选接口调用示例错误的错误信息；

按照所述错误信息对所述候选接口调用示例进行删除，并进行报警。

7.根据权利要求1至6中任一项所述的方法，其特征在于，所述获取指定接口的指定接口参数信息，包括：

获取目标对象上传的指定接口特征参数、指定请求参数以及指定返回参数，其中，所述指定接口特征参数为所述指定接口的访问地址，所述指定返回参数为入参为所述指定请求参数时返回的参数。

8.一种接口调用示例生成装置，其特征在于，包括：

获取模块，用于获取指定接口的指定接口参数信息，其中，所述指定接口为需要生成接口调用示例的接口；

渲染模块，用于通过所述指定接口参数信息对候选示例模板进行渲染，得到候选接口调用示例，其中，所述候选示例模板是调用方系统采用候选软件语言编写时的示例模板，所述候选接口调用示例为采用所述候选软件语言编写的调用方系统对所述指定接口进行调用的代码示例。

9.一种电子设备，包括处理器、通信接口、存储器和通信总线，其中，所述处理器、所述通信接口和所述存储器通过所述通信总线完成相互间的通信，其特征在于，

所述存储器，用于存储计算机程序；

所述处理器，用于通过运行所述存储器上所存储的所述计算机程序来执行权利要求1至7中任一项所述的方法步骤。

10.一种计算机可读的存储介质，其特征在于，所述存储介质中存储有计算机程序，其中，所述计算机程序被设置为运行时执行权利要求1至7中任一项中所述的方法步骤。