[发明专利]一种API接口封装调用方法及系统

说明书

本发明涉及一种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目录文件中扫描并匹配待调用API接口的调用方式、接口名称和接口请求类型，若扫描信息未匹配成功，则生成第三接口配置文件，将待调用API接口的接口名称、接口请求类型、超时和拦截方式加入所述第三接口配置文件中，根据输入的请求参数，判断返回参数是否正确，若返回参数正确，则调用成功，将所述请求参数和返回参数加入第三接口配置文件中，则将所述第三接口配置文件作为新的配置文件，封装结束。

进一步地，调用成功之后，将所述第三接口配置文件中API目录信息添加到API目录文件中。

进一步地，封装结束后，第二或第三接口配置文件包括后续封装时用于识别的API接口的基本信息，所述基本信息包括API的接口名称、接口请求类型、样例请求参数、样例返回参数、超时和拦截方式。