[发明专利]应用程序编程接口生成方法及装置

说明书

本发明是关于一种应用程序编程接口生成方法，属于软件开发技术领域。所述方法包括：获取应用程序编程接口API的协议文档；获取该协议文档中包含的参数信息，并确定API的函数模版；根据该参数信息以及函数模版生成该API。该方法预先设置API的函数模版，在开发API时，开发人员只需要输入API的协议文档，软件开发工具即可以自动根据协议文档获取API的参数信息，并结合参数信息以及API的函数模版自动生成API，不需要开发人员人工编写API的代码，极大的降低了API开发的人工成本，缩短开发时间，从而提高软件开发效率。

技术领域

本发明涉及软件开发技术领域，特别涉及一种应用程序编程接口生成方法及装置。

背景技术

API(Application Programming Interface，应用程序编程接口)是后台系统中预先定义的函数集合，其可以提供应用程序与开发人员基于某软件或硬件来访问一组例程的能力。

在后台系统的开发过程当中，API的开发是其中极为重要的一部分。在现有技术中，API的开发主要通过开发人员的人工编写来完成。比如，开发人员对照预先设置或者编写好的API的协议文档来编写相应的API中各部分函数的代码。

目前的API都由开发人员人工编写，而编写API的代码需要消耗大量的人力成本，且需要耗费一定的开发时间，导致软件的开发效率较低。

发明内容

为了解决现有技术中人工编写API的代码需要消耗大量的人力成本和开发时间，影响软件开发效率的问题，本发明实施例提供了一种应用程序编程接口生成方法及装置，技术方案如下：

第一方面，提供了一种应用程序编程接口生成方法，所述方法包括：

获取应用程序编程接口API的协议文档；

获取所述协议文档中包含的参数信息，并确定所述API的函数模版，所述参数信息包括至少一个参数以及所述至少一个参数的类型，或者，所述参数信息包括所述至少一个参数、所述至少一个参数的类型以及所述至少一个参数之间的嵌套关系；

根据所述参数信息以及所述函数模版生成所述API。

第二方面，提供了一种应用程序编程接口生成装置，所述装置包括：

第一获取模块，用于获取应用程序编程接口API的协议文档；

第二获取模块，用于获取所述协议文档中包含的参数信息，所述参数信息包括至少一个参数以及所述至少一个参数的类型，或者，所述参数信息包括所述至少一个参数、所述至少一个参数的类型以及所述至少一个参数之间的嵌套关系；

模版确定模块，用于确定所述API的函数模版；

生成模块，用于根据所述参数信息以及所述函数模版生成所述API。

本发明实施例提供的技术方案可以包括以下有益效果：

预先设置API的函数模版，在开发API时，开发人员只需要输入API的协议文档，软件开发工具即可以自动根据协议文档获取API的参数信息，并结合参数信息以及API的函数模版自动生成API，不需要开发人员人工编写API的代码，极大的降低了API开发的人工成本，缩短开发时间，从而提高软件开发效率。

应当理解的是，以上的一般描述和后文的细节描述仅是示例性和解释性的，并不能限制本发明。

附图说明

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

图1是本发明所示方案的实现流程示意图；

图2是根据一示例性实施例示出的一种应用程序编程接口生成方法的流程图；