[发明专利]一种接口文档处理方法、装置、电子设备以及存储介质

说明书

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

技术领域

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

背景技术

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

发明内容

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

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

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

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

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

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

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

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

至少一个处理器；以及

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

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

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

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

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

附图说明

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

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

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

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