API文件管理方法、服务器及存储介质技术

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

API file management method, server and storage medium

The invention discloses an API file management method, a server and a storage medium. The method comprises receiving an API file newly uploaded by the server, judging whether the stored API file is changed by the interface or the newly added API file according to the interface name of the API file, and sending a pre-sent if the stored API file is changed by the interface. Set the format of the prompt information to the client, the end of the process, if the new API file, the API code for the new API interface and API file allocation a label, through the label to establish the mapping between API code and API file; Set the relationship between the label and the client address, so as to achieve the interface migration have Effective monitoring to avoid code intrusive.

【技术实现步骤摘要】
API文件管理方法、服务器及存储介质
本专利技术涉及计算机
，尤其涉及一种应用程序接口(ApplicationProgrammingInterface,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文件，则流程进入分配步骤；分配步骤：为新增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接口进行修改。附图说明图1为本专利技术服务器较佳实施例的示意图；图2为本专利技术API文件管理方法的应用环境示意图；图3为图1或图2中API文件管理程序较佳实施例的模块示意图；图4为本专利技术API文件管理方法较佳实施例的流程图；图5为本专利技术API文件管理方法第二实施例的流程图。本专利技术目的的实现、功能特点及优点将结合实施例，参照附图做进一步说明。具体实施方式应当理解，此处所描述的具体实施例仅仅用以解释本专利技术，并不用于限定本专利技术。如图1所示，是本专利技术服务器1较佳实施例的示意图。在本实施例中，服务器1可以是服务器、智能手机、平板电脑、个人电脑、便携计算机以及其它具有运算功能的电子设备。该服务器1包括：存储器11、处理器12、网络接口13、通信总线14及存储在存储器11上并可在所述处理器12上运行的API文件管理程序10。其中，网络接口13可选地可以包括标准的有线接口、无线接口(如WI-FI接口)，通常用于在该服务器与其它电子设备之间建立通信连接。通信总线14用于实现这些组件之间的连接通信。存储器11至少包括一种类型的可读存储介质。所述至少一种类型的可读存储介质可为如闪存、硬盘、多媒体卡、卡型存储器等的非易失性存储介质。在一些实施例中，所述存储器11可以是所述服务器1的内部存储单元，例如该服务器1的硬盘。在另一些实施例中，所述存储器11也可以是所述服务器1的外部存储单元，例如所述服务器1上配备的插接式硬盘，智能存储卡(SmartMediaCard,SMC)，安全数字(SecureDigital,SD)卡，闪存卡(FlashCard,FC)等。在本实施例中，所述存储器11不仅可以用于存储安装于所述服务器1的应用软件及各类数据，例如API文件管理程序10、API接口代码、API文件等，还可以用于暂时地存储已经输出或者将要输出的数据，如接口类。处理器12在一些实施例中可以是一中央处理器(CentralProcessingUnit,CPU)，微处理器或其它数据处理芯片，用于运行存储器11中存储的程序代码或处理数据，例如执行API文件管理程序10的计算机程序代码等。优选地，该服务器1还可以包括显示器，显示器可以称为显示屏或显示单元。在一些实施例中显示器可以是LED显示器、液晶显示器、触控式液晶显示器以及有机发光二极管(OrganicLight-EmittingDiode，OLED)触摸器等。显示器用于显示在服务器1中处理的信息以及用于显示可视化的工作界面。图1仅示出了具有组件11-1本文档来自技高网...

【技术保护点】
1.一种API文件管理方法，应用于服务器，服务器与服务端及客户端相连接，其特征在于，所述方法包括：接收步骤：接收服务端新上传的一份API文件；判断步骤：根据API文件中的接口名称判断是接口变更的已存储API文件，还是新增的API文件，若是接口变更的已存储API文件，则发送预设格式的提示信息给客户端、流程结束，若是新增的API文件，则流程进入分配步骤；分配步骤：为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API文件之间的映射关系；设置步骤：设置该标签与客户端地址之间的关联关系。

【技术特征摘要】
1.一种API文件管理方法，应用于服务器，服务器与服务端及客户端相连接，其特征在于，所述方法包括：接收步骤：接收服务端新上传的一份API文件；判断步骤：根据API文件中的接口名称判断是接口变更的已存储API文件，还是新增的API文件，若是接口变更的已存储API文件，则发送预设格式的提示信息给客户端、流程结束，若是新增的API文件，则流程进入分配步骤；分配步骤：为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API文件之间的映射关系；设置步骤：设置该标签与客户端地址之间的关联关系。2.根据权利要求1所述的API文件管理方法，其特征在于，该方法还包括：在服务器中将API接口的代码与API文件进行分离，提供代码库存储API代码，API文件库存储API文件。3.根据权利要求1所述的API文件管理方法，其特征在于，所述判断步骤还包括：将新上传的API文件的接口名称与API文件库中存储的API文件的接口名称相比较，若新上传的API文件的接口名称与API文件库中存储的某个API文件的接口名称相同，则判断该API文件是接口变更的已存储API文件，若新上传的API文件的接口名称与API文件库中存储的所有API文件的接口名称不同，则判断该API文件是新增的API文件。4.根据权利要求1所述的API文件管理方法，其特征在于，该方法还包括：标签与客户端地址之间的关联关系设置完成后，发送预设格式的反馈信息给服务端。5.根据权利要求1-4任一项所述的API文件管理方法，其特征在于，所述标签是根据标签列表的顺序自动生成一个唯一的标记名称。6.一种服务器，其特征在于，所述服务器包括：存储器、处理器及显示器，所述存储器上存储有AP...

【专利技术属性】
技术研发人员：叶腾飞，
申请(专利权)人：平安科技深圳有限公司，
类型：发明
国别省市：广东,44