[发明专利]一种接口协议文件管理方法和装置

说明书

本发明公开了一种接口协议文件管理方法和装置，涉及计算机技术领域。该方法的一具体实施方式包括：接收对目标接口的开发指令，获取目标接口在开发过程中的最新接口信息；当存在与目标接口相应的协议文件时，根据与目标接口相应的协议规则以及最新接口信息，更新协议文件。该实施方式利用开发工具自定义插件技术，在开发业务接口的同时，就可以利用此插件，按照既定协议规则、自动生成/更新协议文件，并保存在当前项目的资源文件路径中，进而可视化编辑整个协议文件，同时便于后期动态修改、维护，降低现有因手动修改的错误率。

技术领域

本发明涉及计算机技术领域，尤其涉及一种接口协议文件管理方法和装置。

背景技术

随着移动应用与企业间互联需求的兴起，越来越多的企业选择将自身的业务进行对外开放。

为综合管理这些开放性业务，需要统一的API(Application ProgrammingInterface，应用程序编程接口)网关系统来进行集中管理。企业内部业务对外发布时，需要依赖协议文件描述业务接口信息，然后结合业务接口，导入API网关系统中进行发布。

现有系统中的协议文件，通常是通过应用自动生成工具/代码一次性生成。但在实现本发明的过程中，发明人发现现有技术至少存在如下问题：

1)对于已生成的协议文件，会经常因为业务的变更需要进行修改，但由于协议文件是通过生成工具一次性生成，需要线下对协议文件做手动修改，修改后的内容依赖工具再生成文件，然后替换掉原协议文件；

2)目前协议文件描述较为复杂，开发人员编写/修改这些协议文件很容易出错、且效率较低。

发明内容

有鉴于此，本发明实施例提供一种接口协议文件管理方法和装置，至少能够解决现有技术中协议文件只能一次性生成，且不支持动态修改的问题。

为实现上述目的，根据本发明实施例的一个方面，提供了一种接口协议文件管理方法，包括：

接收对目标接口的开发指令，获取所述目标接口在开发过程中的最新接口信息；

当存在与所述目标接口相应的协议文件时，根据与所述目标接口相应的协议规则以及所述最新接口信息，更新所述协议文件。

可选的，在更新所述协议文件之后，还包括：

根据软件版本与软件开发包的对应关系，转换更新后的协议文件为相应软件版本的软件开发包；

接收客户端传输的软件开发包调用请求，提取与所述客户端的软件版本相应的软件开发包并传输至所述客户端。

可选的，在更新所述协议文件之后，还包括：根据网关系统中的预定文档生成规则，生成与更新后的协议文件相应的网关文档。

可选的，接口信息至少包括接口名、方法名、入参、出参以及异常信息；所述协议规则至少包括接口节点、方法节点、入参属性节点、出参节点以及异常信息节点。

为实现上述目的，根据本发明实施例的另一方面，提供了一种接口协议文件管理装置，包括：

接口信息获取模块，用于接收对目标接口的开发指令，获取所述目标接口在开发过程中的最新接口信息；

协议文件更新模块，用于当存在与所述目标接口相应的协议文件时，根据与所述目标接口相应的协议规则以及所述最新接口信息，更新所述协议文件。

可选的，还包括软件开发包生成模块，用于：

根据软件版本与软件开发包的对应关系，转换更新后的协议文件为相应软件版本的软件开发包；

接收客户端传输的软件开发包调用请求，提取与所述客户端的软件版本相应的软件开发包并传输至所述客户端。