[发明专利]API文件管理方法、服务器及存储介质

说明书

本发明公开了一种API文件管理方法、服务器及存储介质，该方法包括：接收服务端新上传的一份API文件；根据API文件中的接口名称判断是接口变更的已存储API文件，还是新增的API文件，若是接口变更的已存储API文件，则发送预设格式的提示信息给客户端、流程结束，若是新增的API文件，则为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API文件之间的映射关系；设置该标签与客户端地址之间的关联关系，从而实现接口迁移的有效监控，避免代码侵入性。

技术领域

本发明涉及计算机技术领域，尤其涉及一种应用程序接口(ApplicationProgramming Interface,API)文件管理方法、服务器及计算机可读存储介质。

背景技术

API文件是关于API接口调用的描述性文件，每个API文件包括API接口和 API接口调用说明。目前，API文件的管理主要有两种，一种是在实现API接口的代码中加大量注释，通过工具自动生成rest风格的API文件，这种类型的API 文件具有很强的代码入侵性，大大降低代码的可读性；另一种是创建markdown 文件，在markdown文件中添加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文件库中存储的某个API 文件的接口名称相同，则判断该API文件是接口变更的已存储API文件，若新上传的API文件的接口名称与API文件库中存储的所有API文件的接口名称不同，则判断该API文件是新增的API文件。

优选地，该方法还包括：标签与客户端地址之间的关联关系设置完成后，发送预设格式的反馈信息给服务端。

优选地，所述标签是根据标签列表的顺序自动生成一个唯一的标记名称。

此外，本发明还提供一种服务器，该服务器包括：存储器、处理器、显示器及存储在所述存储器上并可在所述处理器上运行的API文件管理程序，所述API文件管理程序被所述处理器执行，可实现如下步骤：

接收步骤：接收服务端新上传的一份API文件；

判断步骤：根据API文件中的接口名称判断是接口变更的已存储API文件，还是新增的API文件，若是已存储API文件的接口变更，则发送预设格式的提示信息给客户端、流程结束，若是新增的API文件，则流程进入分配步骤；