CN112015468A - 一种接口文档处理方法、装置、电子设备以及存储介质 - Google Patents

Abstract

本申请公开了一种接口文档处理方法、装置、电子设备以及存储介质，涉及云计算技术领域，进一步涉及应用程序接口开发等领域。具体实现方案为：根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表，确定所述服务请求示例中请求参数的目标描述信息；根据所述请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。解决了目前生成接口文档中参数调用说明方式存在成本高以及效率低下等问题，提供了一种对应用程序接口文档进行处理的方案，无需应用程序接口提供方进行繁琐的手动输入过程，能够自动、高效且低成本生成接口文档中参数调用说明内容。

Description

一种接口文档处理方法、装置、电子设备以及存储介质

技术领域

本申请涉及云计算技术领域，尤其涉及软件开发与测试，以及智能搜索技术，具体涉及一种接口文档处理方法、装置、电子设备以及存储介质。

背景技术

随着计算机技术的发展，应用程序接口(Application Programming Interface，API)开发与应用越来越普遍。应用程序接口提供方需要对提供的服务配置全面且完善的使用说明(即接口文档)，以便调用者基于接口文档调用接口。其中，接口文档中参数的调用说明最为繁琐和复杂。然而，目前主要通过人工手动编辑的方式生成参数的调用说明，成本高且效率低，亟需改进。

发明内容

本公开提供了一种接口文档处理方法、装置、电子设备以及存储介质，以低成本且高效生成接口文档中参数的调用说明内容。

根据本公开的一方面，提供了一种接口文档处理方法，该方法包括：

根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表，确定所述服务请求示例中请求参数的目标描述信息；

根据所述请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

根据本公开的另一方面，提供了一种接口文档处理装置，该装置包括：

目标信息确定模块，用于根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表，确定所述服务请求示例中请求参数的目标描述信息；

内容生成模块，用于根据所述请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

根据本公开的另一方面，提供了一种电子设备，该电子设备包括：

至少一个处理器；以及

与所述至少一个处理器通信连接的存储器；其中，

所述存储器存储有可被所述至少一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够执行本申请任一实施例所述的接口文档处理方法。

根据本公开的另一方面，提供了一种存储有计算机指令的非瞬时计算机可读存储介质，其中，所述计算机指令用于使所述计算机执行本申请任一实施例所述的接口文档处理方法。

根据本申请的技术解决了目前生成接口文档中参数调用说明方式存在成本高以及效率低下等问题，提供了一种对应用程序接口文档进行处理的方案，无需应用程序接口提供方进行繁琐的手动输入过程，能够自动、高效且低成本生成接口文档中参数调用说明内容。

应当理解，本部分所描述的内容并非旨在标识本公开的实施例的关键或重要特征，也不用于限制本公开的范围。本公开的其它特征将通过以下的说明书而变得容易理解。

附图说明

附图用于更好地理解本方案，不构成对本申请的限定。其中：

图1是根据本申请实施例提供的一种接口文档处理方法的流程图；

图2是根据本申请实施例提供的另一种接口文档处理方法的流程图；

图3是根据本申请实施例提供的又一种接口文档处理方法的流程图；

图4是根据本申请实施例提供的一种接口文档处理装置的结构示意图；

图5是用来实现本申请实施例的接口文档处理方法的电子设备的框图。

具体实施方式

以下结合附图对本申请的示范性实施例做出说明，其中包括本申请实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本申请的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知功能和结构的描述。

图1是根据本申请实施例提供的一种接口文档处理方法的流程图。本申请实施例适用于如何对接口文档进行处理的情况，尤其适用于如何高效且低成本生成接口文档中参数的调用说明。该实施例可以由接口文档处理装置来执行，该装置可以采用软件和/或硬件来实现，并可集成于承载接口文档处理功能的电子设备中，如电子设备中API网关控制平台中。如图1所示，该方法包括：

S101，根据应用程序接口提供方提供的服务请求示例和服务请求示例关联的参数列表，确定服务请求示例中请求参数的目标描述信息。

本实施例中，应用程序接口提供方即开发应用程序接口的一方，或者也可以说是对外提供应用程序接口调用服务的一方。可选的，一个应用程序接口可以提供一种类型服务，也就是说一个应用程序接口的所有服务请求的数据格式相同，服务请求示例为应用程序接口所能够提供服务的一种示例，实质是一个真实的应用程序接口调用请求。此外，应用程序接口提供方在开发应用程序接口时可以采用规范的数据结构，如可以采用JAVA、Json或者C语言等。由于Json数据结构具有简洁、层次清晰、易于编写、以及易于转换等特点，本实施例中应用程序接口提供方在开发应用程序接口时优选采用Json数据结构进行编写。进而应用程序接口提供方所提供的服务请求示例可以为采用Json数据结构编写得到。

本实施例中，应用程序接口提供方可以从自己的业务日志中获取一个服务请求示例，并提供给API网关控制平台。进一步的，API网关控制平台可以提供可视化交互界面，进而应用程序接口提供方在具有生成应用程序接口文档中参数调用说明需求时，可以根据可视化交互界面中提示信息输入相关内容，如可以将业务日志中的一个服务请求示例粘贴复制到可视化交互界面中，进而API网关控制平台可以从可视化交互界面中获取应用程序接口提供方提供的服务请求示例。

进一步的，服务请求示例中可以包括调用应用程序接口时所需调用的所有请求参数，具体可以包括所有请求参数的参数名称、参数类型和示例值等，但无法涉及请求参数的所有内容信息。进而，应用程序接口提供方还可以向API网关控制平台提供服务请求示例关联的参数列表。本实施例中，服务请求示例关联的参数列表为应用程序接口提供方在开发应用程序接口过程中本地维护的参数详情表单，可以包括服务请求示例中部分或全部请求参数，且参数列表中所包括的每一请求参数的详情内容中可以包括所需向接口调用者展示但服务请求示例中无法体现的请求参数的其他内容信息，如参数位置、参数取值范围、参数描述、是否必需、可选值以及参数校验规则等。

本实施例中，应用程序接口提供方在可视化交互界面中输入服务请求示例的同时，可以将本地维护的参数列表粘贴复制到可视化交互界面中，或者可以将本地维护的参数列表导入可视化交互界面中，进而API网关控制平台可以从可视化交互界面中获取应用程序接口关联的参数列表。

可选的，API网关控制平台获取应用程序接口提供方提供的服务请求示例和参数列表之后，可以从服务请求示例中提取所有请求参数，并结合参数列表，按照预先设定的数据格式对请求参数进行描述，进而得到请求参数的目标描述信息。本实施例中，目标描述信息可以采用通用的描述参数信息的规范格式，完善的展示出服务请求示例中所有参数的详情内容，具体可以包括服务请求示例中所有请求参数以及参数列表中请求参数的详情内容等。进一步的，为了便于快速生成接口文档中参数调用说明部分相关内容，以及为使其他调用者无需进行数据格式转换便能够对应用程序接口进行导出、导入操作等，本实施例中，目标描述信息优选采用Json Schema数据结构编写。

可选的，在服务请求示例为采用Json数据结构编写得到，且目标描述信息为采用Json Schema数据结构编写得到的情况下，可以采用Json数据结构和Json Schema数据结构之间的转化算法，结合服务请求示例和参数列表，得到服务请求示例中请求参数的目标描述信息。

S102，根据请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

具体的，在得到请求参数的目标描述信息之后，可以基于预先设定的参数调用说明格式，根据请求参数的目标描述信息，生成应用程序接口文档中参数调用说明的相关内容。例如，可以直接对请求参数的目标描述信息进行格式转换，如转化到设定的参数调用说明格式，进而得到应用程序接口文档中参数调用说明的相关内容。

需要说明的是，由于一个应用程序接口可能涉及很多请求参数，现有通过人工手动编辑生成参数的调用说明方式，存在效率低下且成本高等问题；而本申请通过采用服务请求实例和参数列表相结合的方式，不仅能够降低应用程序提供方的输入成本，同时能够较为完善的展示出请求参数的所有信息，提升了用户的体验。为自动、高效且低成本生成接口文档中参数调用说明内容提供了一种新思路。此外，本实施例中应用程序接口提供方也无需关注参数列表的格式，增加用户的满意度。

本申请实施例的技术方案，通过采用服务请求实例和参数列表相结合的方式，可以得到服务请求示例中所有请求参数的目标描述信息，进而可得到丰富的参数调用说明。解决了目前生成接口文档中参数调用说明方式存在成本高以及效率低下等问题，提供了一种对应用程序接口文档进行处理的方案，无需应用程序接口提供方进行繁琐的手动输入过程，能够自动、高效且低成本生成接口文档中参数调用说明内容。

图2是根据本申请实施例提供的另一种接口文档处理方法的流程图。本实施例在上述实施例的基础上，进一步对根据应用程序接口提供方提供的服务请求示例和服务请求示例关联的参数列表，确定服务请求示例中请求参数的目标描述信息进行解释说明。如图2所示，该方法包括：

S201，对服务请求示例进行解析，得到服务请求示例中请求参数的基础描述信息。

本实施例中，基础描述信息为确定请求参数的目标描述信息的中间桥梁，可以采用通用的描述参数信息的规范格式；进一步的，为便于快速生成目标描述信息，本实施例中可以采用与目标描述信息相同的数据格式，例如基础描述信息可以采用Json Schema数据结构编写。

具体的，可以采用递归遍历的方式从服务请求示例中解析出所有请求参数，具体为解析出所有请求参数的参数名称和参数类型，进一步的在请求参数有示例值的情况下，还可以解析出示例值；之后可以按照预先设定的数据格式对所解析出的请求参数的参数名称、参数类型和示例值等进行描述，进而得到请求参数的基础描述信息。可选的，基础描述信息中可以包括请求参数的参数名称和参数类型，还可以包括请求参数的示例值等。

进一步的，在服务请求示例为采用Json数据结构编写得到，且基础描述信息为采用Json Schema数据结构编写得到的情况下，例如服务请求示例如下：

{"instanceType":"N1",

"tags":[{"tagKey":"tag1","tagValue":"var1"}]

}

由于标准的Json数据结构以键值对(Key-Value)的形式对请求进行表示，进而通过递归遍历的方式，基于Json数据结构和Json Schema数据结构，能够从服务请求示例中解析出所有请求参数的参数名称和参数类型等。其中，本实施例以参数名称作为Key，以参数示例值作为Value。例如，通过对上述服务请求示例进行解析，可以得到参数名称为instanceType、示例值为N1的请求参数；由于该请求参数的示例值N1是一个字符串，所以可得到该请求参数的参数类型为string。通过上述逻辑，基于Json Schema数据结构，可得到如下基础描述信息：

S202，根据请求参数的基础描述信息和服务请求示例关联的参数列表，得到请求参数的目标描述信息。

可选的，可以根据服务请求示例关联的参数列表，对请求参数的基础描述信息进行扩展，进而得到请求参数的目标描述信息。例如，在基础描述信息和目标描述信息均采用Json Schema数据结构编写的情况下，可以根据参数列表，按照Json Schema数据结构对基础描述信息中对应的请求参数进行扩展，进而得到请求参数的目标描述信息。

S203，根据请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

本申请实施例的技术方案，通过引入基础描述信息，以基础描述信息为确定请求参数的目标描述信息的中间桥梁，为快速生成请求参数的目标描述信息提供了一种可选方式。此外，本实施例中目标描述信息采用Json Schema标准的数据描述规范，为各调用者导入应用程序接口提供了便利。

进一步的，为便于快速得到目标描述信息，本实施例中S202可以是：根据请求参数的基础描述信息中的参数名称，从服务请求示例关联的参数列表中进行匹配；进而根据匹配结果，对请求参数的基础描述信息进行扩展，得到请求参数的目标描述信息。

具体的，可以以请求参数的基础描述信息中的参数名称为索引，从服务请求示例关联的参数列表中进行匹配。例如，应用程序接口提供方提供的服务请求示例为步骤S202中所示，且服务请求示例关联的参数列表如表1所示。可以以instanceType为索引，从服务请求示例关联的参数列表中进行匹配，可从该列表中获取参数名称为instanceType的请求参数的所有详情内容，如是否必须、描述和参数类型等，进而可根据获取的参数名称为instanceType的请求参数的所有详情内容，对该请求参数的基础描述信息进行扩展，可得到该请求参数的目标描述信息。例如：

{"type":"object",

"properties":{"instanceType":{"type":"string"，"description":"待创建虚拟机实例的类型","example":"N1"}}}。

基于上述逻辑，可以得到其他请求参数(包括tags、tagKey和tagValue)的目标描述信息。本实施例通过以参数名称连结基础描述信息和参数列表，为快速生成请求参数的目标描述信息提供了一种可选方式。

表1 服务请求示例关联的参数列表

为了保证目标描述信息的准确度，进一步的，在参数列表的请求参数包括参数类型的情况下，可以比较请求参数的基础描述信息中的参数类型是否与参数列表中请求参数的参数类型是否一致，若不一致，则可以以基础描述信息中的参数类型为准。

图3是根据本申请实施例提供的又一种接口文档处理方法的流程图。本实施例在上述实施例的基础上，又进一步对根据应用程序接口提供方提供的服务请求示例和服务请求示例关联的参数列表，确定服务请求示例中请求参数的目标描述信息进行解释说明。如图3所示，该方法包括：

S301，将服务请求示例中参数名称相同且参数值不同的请求参数，作为重复请求参数。

可以理解的是，对于Json数据结构，同一层级下参数名称唯一，不同层级下参数名称可以相同。进而一个服务请求示例中可能存在参数名称相同的请求参数。为了保证目标描述信息的准确度，本实施例可通过S301和S302对参数名称相同的请求参数进行处理。

具体的，可以通过遍历方式，从服务请求示例中获取参数名称相同且参数值不同的请求参数，并将该请求参数作为重复请求参数。

例如，应用程序接口的服务请求示例如下所示，其中参数名称为key1、参数值为value1的请求参数，与参数名称为key1、参数值为111的请求参数，参数名称相同但参数值不同，进而可以将参数名称为key1的请求参数作为重复请求参数。

S302，根据重复请求参数在服务请求示例中的位置信息和服务请求示例关联的参数列表，构建重复请求参数关联的参数详情队列。

可选的，可以根据重复请求参数的参数名称，获取各重复请求参数在服务请求示例中的位置信息，其中，位置信息可以是重复请求参数所在服务请求示例中的行数，例如参数名称为key1、参数值为value1的重复请求参数位于服务请求示例的第一行。

之后根据位置信息，构建包括参数值的第一队列，例如["value1","111"]；根据参数名称、位置信息和参数列表，构架包括参数列表中详情内容的第二队列，例如["这是一个字符串","这是一个数值"]；根据第一队列和第二队列，构建重复请求参数关联的参数详情队列，例如["value1"："这是一个字符串","111"："这是一个数值"]。

S303，根据服务请求示例、服务请求示例关联的参数列表和参数详情队列，确定服务请求示例中请求参数的目标描述信息。

具体的，可以根据服务请求示例，得到服务请求示例中请求参数的基础描述信息；根据请求参数的基础描述信息、服务请求示例关联的参数列表和参数详情队列，可以确定服务请求示例中请求参数的目标描述信息。

S304，根据请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

本申请实施例的技术方案，通过引入参数详情队列，基于队列先进先出的特性，保证了参数列表中参数名称的有序性，进而可准确的得到请求参数的目标描述信息。

图4是根据本申请实施例提供的一种接口文档处理装置的结构示意图。本申请实施例适用于如何对接口文档进行处理的情况，尤其适用于如何高效且低成本生成接口文档中参数的调用说明。该装置可实现本申请任意实施例所述的接口文档处理方法。该装置可集成于承载接口文档处理功能的电子设备中。该接口文档处理装置400具体包括：

目标信息确定模块401，用于根据应用程序接口提供方提供的服务请求示例和服务请求示例关联的参数列表，确定服务请求示例中请求参数的目标描述信息；

内容生成模块402，用于根据请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

本申请实施例的技术方案，通过采用服务请求实例和参数列表相结合的方式，可以得到服务请求示例中所有请求参数的目标描述信息，进而可得到丰富的参数调用说明。解决了目前生成接口文档中参数调用说明方式存在成本高以及效率低下等问题，提供了一种对应用程序接口文档进行处理的方案，无需应用程序接口提供方进行繁琐的手动输入过程，能够自动、高效且低成本生成接口文档中参数调用说明内容。

示例性的，目标信息确定模块401包括：

基础信息确定单元，用于对服务请求示例进行解析，得到服务请求示例中请求参数的基础描述信息；基础描述信息包括参数名称和参数类型；

目标信息确定单元，用于根据请求参数的基础描述信息和服务请求示例关联的参数列表，得到请求参数的目标描述信息。

示例性的，目标信息确定模块401具体用于：

将服务请求示例中参数名称相同且参数值不同的请求参数，作为重复请求参数；

根据重复请求参数在服务请求示例中的位置信息和服务请求示例关联的参数列表，构建重复请求参数关联的参数详情队列；

根据服务请求示例、服务请求示例关联的参数列表和参数详情队列，确定服务请求示例中请求参数的目标描述信息。

示例性的，目标信息确定单元具体用于：

根据请求参数的基础描述信息中的参数名称，从服务请求示例关联的参数列表中进行匹配；

根据匹配结果，对请求参数的基础描述信息进行扩展，得到请求参数的目标描述信息。

示例性的，本实施例中服务请求示例采用Json数据结构编写；目标描述信息和基础描述信息采用Json Schema数据结构编写。

根据本申请的实施例，本申请还提供了一种电子设备和一种可读存储介质。

如图5所示，是根据本申请实施例的接口文档处理方法的电子设备的框图。电子设备旨在表示各种形式的数字计算机，诸如，膝上型计算机、台式计算机、工作台、个人数字助理、服务器、刀片式服务器、大型计算机、和其它适合的计算机。电子设备还可以表示各种形式的移动装置，诸如，个人数字处理、蜂窝电话、智能电话、可穿戴设备和其它类似的计算装置。本文所示的部件、它们的连接和关系、以及它们的功能仅仅作为示例，并且不意在限制本文中描述的和/或者要求的本申请的实现。

如图5所示，该电子设备包括：一个或多个处理器501、存储器502，以及用于连接各部件的接口，包括高速接口和低速接口。各个部件利用不同的总线互相连接，并且可以被安装在公共主板上或者根据需要以其它方式安装。处理器可以对在电子设备内执行的指令进行处理，包括存储在存储器中或者存储器上以在外部输入/输出装置(诸如，耦合至接口的显示设备)上显示GUI的图形信息的指令。在其它实施方式中，若需要，可以将多个处理器和/或多条总线与多个存储器和多个存储器一起使用。同样，可以连接多个电子设备，各个设备提供部分必要的操作(例如，作为服务器阵列、一组刀片式服务器、或者多处理器系统)。图5中以一个处理器501为例。

存储器502即为本申请所提供的非瞬时计算机可读存储介质。其中，所述存储器存储有可由至少一个处理器执行的指令，以使所述至少一个处理器执行本申请所提供的接口文档处理方法。本申请的非瞬时计算机可读存储介质存储计算机指令，该计算机指令用于使计算机执行本申请所提供的接口文档处理方法。

存储器502作为一种非瞬时计算机可读存储介质，可用于存储非瞬时软件程序、非瞬时计算机可执行程序以及模块，如本申请实施例中的接口文档处理方法对应的程序指令/模块(例如，附图4所示的目标信息确定模块401和内容生成模块402)。处理器501通过运行存储在存储器502中的非瞬时软件程序、指令以及模块，从而执行服务器的各种功能应用以及数据处理，即实现上述方法实施例中的接口文档处理方法。

存储器502可以包括存储程序区和存储数据区，其中，存储程序区可存储操作系统、至少一个功能所需要的应用程序；存储数据区可存储根据接口文档处理方法的电子设备的使用所创建的数据等。此外，存储器502可以包括高速随机存取存储器，还可以包括非瞬时存储器，例如至少一个磁盘存储器件、闪存器件、或其他非瞬时固态存储器件。在一些实施例中，存储器502可选包括相对于处理器501远程设置的存储器，这些远程存储器可以通过网络连接至接口文档处理方法的电子设备。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

接口文档处理方法的电子设备还可以包括：输入装置503和输出装置504。处理器501、存储器502、输入装置503和输出装置504可以通过总线或者其他方式连接，图5中以通过总线连接为例。

输入装置503可接收输入的数字或字符信息，以及产生与接口文档处理方法的电子设备的用户设置以及功能控制有关的键信号输入，例如触摸屏、小键盘、鼠标、轨迹板、触摸板、指示杆、一个或者多个鼠标按钮、轨迹球、操纵杆等输入装置。输出装置504可以包括显示设备、辅助照明装置(例如，LED)和触觉反馈装置(例如，振动电机)等。该显示设备可以包括但不限于，液晶显示器(LCD)、发光二极管(LED)显示器和等离子体显示器。在一些实施方式中，显示设备可以是触摸屏。

此处描述的系统和技术的各种实施方式可以在数字电子电路系统、集成电路系统、专用ASIC(专用集成电路)、计算机硬件、固件、软件、和/或它们的组合中实现。这些各种实施方式可以包括：实施在一个或者多个计算机程序中，该一个或者多个计算机程序可在包括至少一个可编程处理器的可编程系统上执行和/或解释，该可编程处理器可以是专用或者通用可编程处理器，可以从存储系统、至少一个输入装置、和至少一个输出装置接收数据和指令，并且将数据和指令传输至该存储系统、该至少一个输入装置、和该至少一个输出装置。

这些计算程序(也称作程序、软件、软件应用、或者代码)包括可编程处理器的机器指令，并且可以利用高级过程和/或面向对象的编程语言、和/或汇编/机器语言来实施这些计算程序。如本文使用的，术语“机器可读介质”和“计算机可读介质”指的是用于将机器指令和/或数据提供给可编程处理器的任何计算机程序产品、设备、和/或装置(例如，磁盘、光盘、存储器、可编程逻辑装置(PLD))，包括，接收作为机器可读信号的机器指令的机器可读介质。术语“机器可读信号”指的是用于将机器指令和/或数据提供给可编程处理器的任何信号。

为了提供与用户的交互，可以在计算机上实施此处描述的系统和技术，该计算机具有：用于向用户显示信息的显示装置(例如，CRT(阴极射线管)或者LCD(液晶显示器)监视器)；以及键盘和指向装置(例如，鼠标或者轨迹球)，用户可以通过该键盘和该指向装置来将输入提供给计算机。其它种类的装置还可以用于提供与用户的交互；例如，提供给用户的反馈可以是任何形式的传感反馈(例如，视觉反馈、听觉反馈、或者触觉反馈)；并且可以用任何形式(包括声输入、语音输入或者、触觉输入)来接收来自用户的输入。

可以将此处描述的系统和技术实施在包括后台部件的计算系统(例如，作为数据服务器)、或者包括中间件部件的计算系统(例如，应用服务器)、或者包括前端部件的计算系统(例如，具有图形用户界面或者网络浏览器的用户计算机，用户可以通过该图形用户界面或者该网络浏览器来与此处描述的系统和技术的实施方式交互)、或者包括这种后台部件、中间件部件、或者前端部件的任何组合的计算系统中。可以通过任何形式或者介质的数字数据通信(例如，通信网络)来将系统的部件相互连接。通信网络的示例包括：局域网(LAN)、广域网(WAN)、互联网和区块链网络。

计算机系统可以包括客户端和服务器。客户端和服务器一般远离彼此并且通常通过通信网络进行交互。通过在相应的计算机上运行并且彼此具有客户端-服务器关系的计算机程序来产生客户端和服务器的关系。服务器可以是云服务器，又称为云计算服务器或云主机，是云计算服务体系中的一项主机产品，以解决了传统物理主机与VPS服务中，存在的管理难度大，业务扩展性弱的缺陷。

根据本申请实施例的技术方案，通过采用服务请求实例和参数列表相结合的方式，可以得到服务请求示例中所有请求参数的目标描述信息，进而可得到丰富的参数调用说明。解决了目前生成接口文档中参数调用说明方式存在成本高以及效率低下等问题，提供了一种对应用程序接口文档进行处理的方案，无需应用程序接口提供方进行繁琐的手动输入过程，能够自动、高效且低成本生成接口文档中参数调用说明内容。

应该理解，可以使用上面所示的各种形式的流程，重新排序、增加或删除步骤。例如，本发申请中记载的各步骤可以并行地执行也可以顺序地执行也可以不同的次序执行，只要能够实现本申请公开的技术方案所期望的结果，本文在此不进行限制。

上述具体实施方式，并不构成对本申请保护范围的限制。本领域技术人员应该明白的是，根据设计要求和其他因素，可以进行各种修改、组合、子组合和替代。任何在本申请的精神和原则之内所作的修改、等同替换和改进等，均应包含在本申请保护范围之内。

Claims (12)

1.一种接口文档处理方法，包括：

根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表，确定所述服务请求示例中请求参数的目标描述信息；

根据所述请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

2.根据权利要求1所述的方法，其中，根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表，确定所述服务请求示例中请求参数的目标描述信息，包括：

对所述服务请求示例进行解析，得到所述服务请求示例中请求参数的基础描述信息；所述基础描述信息包括参数名称和参数类型；

根据所述请求参数的基础描述信息和所述服务请求示例关联的参数列表，得到所述请求参数的目标描述信息。

3.根据权利要求1所述的方法，其中，根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表，确定所述服务请求示例中请求参数的目标描述信息，包括：

将所述服务请求示例中参数名称相同且参数值不同的请求参数，作为重复请求参数；

根据所述重复请求参数在所述服务请求示例中的位置信息和所述服务请求示例关联的参数列表，构建所述重复请求参数关联的参数详情队列；

根据所述服务请求示例、所述服务请求示例关联的参数列表和所述参数详情队列，确定所述服务请求示例中请求参数的目标描述信息。

4.根据权利要求2所述的方法，其中，根据所述请求参数的基础描述信息和所述服务请求示例关联的参数列表，得到所述请求参数的目标描述信息，包括：

根据所述请求参数的基础描述信息中的参数名称，从所述服务请求示例关联的参数列表中进行匹配；

根据匹配结果，对所述请求参数的基础描述信息进行扩展，得到所述请求参数的目标描述信息。

5.根据权利要求2所述的方法，其中，所述服务请求示例采用Json数据结构编写；所述目标描述信息和所述基础描述信息采用Json Schema数据结构编写。

6.一种接口文档处理装置，包括：

目标信息确定模块，用于根据应用程序接口提供方提供的服务请求示例和所述服务请求示例关联的参数列表，确定所述服务请求示例中请求参数的目标描述信息；

内容生成模块，用于根据所述请求参数的目标描述信息，生成应用程序接口文档中参数调用说明内容。

7.根据权利要求6所述的装置，其中，所述目标信息确定模块包括：

基础信息确定单元，用于对所述服务请求示例进行解析，得到所述服务请求示例中请求参数的基础描述信息；所述基础描述信息包括参数名称和参数类型；

目标信息确定单元，用于根据所述请求参数的基础描述信息和所述服务请求示例关联的参数列表，得到所述请求参数的目标描述信息。

8.根据权利要求6所述的装置，其中，所述目标信息确定模块具体用于：

将所述服务请求示例中参数名称相同且参数值不同的请求参数，作为重复请求参数；

根据所述重复请求参数在所述服务请求示例中的位置信息和所述服务请求示例关联的参数列表，构建所述重复请求参数关联的参数详情队列；

根据所述服务请求示例、所述服务请求示例关联的参数列表和所述参数详情队列，确定所述服务请求示例中请求参数的目标描述信息。

9.根据权利要求7所述的装置，其中，所述目标信息确定单元具体用于：

根据所述请求参数的基础描述信息中的参数名称，从所述服务请求示例关联的参数列表中进行匹配；

根据匹配结果，对所述请求参数的基础描述信息进行扩展，得到所述请求参数的目标描述信息。

10.根据权利要求7所述的装置，其中，所述服务请求示例采用Json数据结构编写；所述目标描述信息和所述基础描述信息采用Json Schema数据结构编写。

11.一种电子设备，包括：

至少一个处理器；以及

与所述至少一个处理器通信连接的存储器；其中，

所述存储器存储有可被所述至少一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够执行权利要求1-5中任一项所述的接口文档处理方法。

12.一种存储有计算机指令的非瞬时计算机可读存储介质，其中，所述计算机指令用于使所述计算机执行权利要求1-5中任一项所述的接口文档处理方法。

Images