CN108427560A - Api文件管理方法、服务器及存储介质 - Google Patents

Api文件管理方法、服务器及存储介质 Download PDF

Info

Publication number
CN108427560A
CN108427560A CN201810026284.XA CN201810026284A CN108427560A CN 108427560 A CN108427560 A CN 108427560A CN 201810026284 A CN201810026284 A CN 201810026284A CN 108427560 A CN108427560 A CN 108427560A
Authority
CN
China
Prior art keywords
api
files
interface
newly
server
Prior art date
Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
Pending
Application number
CN201810026284.XA
Other languages
English (en)
Inventor
叶腾飞
Current Assignee (The listed assignees may be inaccurate. Google has not performed a legal analysis and makes no representation or warranty as to the accuracy of the list.)
Ping An Technology Shenzhen Co Ltd
Original Assignee
Ping An Technology Shenzhen Co Ltd
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by Ping An Technology Shenzhen Co Ltd filed Critical Ping An Technology Shenzhen Co Ltd
Priority to CN201810026284.XA priority Critical patent/CN108427560A/zh
Priority to PCT/CN2018/077655 priority patent/WO2019136813A1/zh
Publication of CN108427560A publication Critical patent/CN108427560A/zh
Pending legal-status Critical Current

Links

Classifications

    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F8/00—Arrangements for software engineering
    • G06F8/60—Software deployment

Landscapes

  • Engineering & Computer Science (AREA)
  • Software Systems (AREA)
  • General Engineering & Computer Science (AREA)
  • Theoretical Computer Science (AREA)
  • Physics & Mathematics (AREA)
  • General Physics & Mathematics (AREA)
  • Information Transfer Between Computers (AREA)
  • Stored Programmes (AREA)

Abstract

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

Description

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文件，则流程进入分配步骤；
分配步骤：为新增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上配备的插接式硬盘，智能存储卡(Smart Media Card,SMC)，安全数字(Secure Digital,SD)卡，闪存卡(Flash Card,FC) 等。
在本实施例中，所述存储器11不仅可以用于存储安装于所述服务器1的应用软件及各类数据，例如API文件管理程序10、API接口代码、API文件等，还可以用于暂时地存储已经输出或者将要输出的数据，如接口类。
处理器12在一些实施例中可以是一中央处理器(Central Processing Unit,CPU)，微处理器或其它数据处理芯片，用于运行存储器11中存储的程序代码或处理数据，例如执行API文件管理程序10的计算机程序代码等。
优选地，该服务器1还可以包括显示器，显示器可以称为显示屏或显示单元。在一些实施例中显示器可以是LED显示器、液晶显示器、触控式液晶显示器以及有机发光二极管(Organic Light-Emitting Diode，OLED)触摸器等。显示器用于显示在服务器1中处理的信息以及用于显示可视化的工作界面。
图1仅示出了具有组件11-14以及执行API文件管理程序10的计算机程序代码的服务器1，但是应理解的是，并不要求实施所有示出的组件，可以替代的实施更多或者更少的组件。
优选地，该服务器1还可以包括输入单元比如键盘(Keyboard)、语音输出装置比如音响、耳机等。
在图1所示的服务器1实施例中，作为一种计算机存储介质的存储器11 中存储API文件管理程序10的程序代码，处理器12执行API文件管理程序10的程序代码时，实现如下步骤：
接收步骤：接收服务端新上传的一份API文件；
判断步骤：根据API文件中的接口名称判断是接口变更的已存储API文件，还是新增的API文件，若是接口变更的已存储API文件，则发送预设格式的提示信息给客户端、流程结束，若是新增的API文件，则流程进入分配步骤；
分配步骤：为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API文件之间的映射关系；
设置步骤：设置该标签与客户端地址之间的关联关系。
本实施例中，如图2所示，是本发明API文件管理方法的应用环境示意图。服务器1将API代码与API文件进行分离，提供API代码库15存储API 接口的代码，API文件库16存储API文件，但API代码库15与API文件库由服务器1统一管理分配。当API文件管理程序10接收到服务端3新上传的一份API文件时，启动API文件管理程序10。其中，所述API文件是API接口的描述性文件，每个API文件包括API文件接口名称和API接口调用说明，所述API接口调用说明包括API接口中的方法、类的功能、参数等相关说明。以人脸识别接口为例对本发明的方案进行解释，当接收到服务端3新上传一份关于人脸识别API接口的API文件时，启动API文件管理程序10。所述服务端3指该API文件对应的API接口的提供方。所述客户端4指该API文件对应的API接口的调用方。例如，服务端3提供人脸识别接口，客户端4调用人脸识别接口进行人脸识别应用。
API文件管理程序10通过上传的API文件的接口名称判断该API文件是接口变更的已存储API文件，还是新增的API文件。假设判断出上传的API 文件是接口变更的已存储API文件，则发送预设格式的接口变更提示信息给客户端4。例如，通过上传的API文件的接口名称判断该API文件是人脸识别API接口变更的已存储的API文件，则向客户端4发送接口变更提示信息，如“人脸识别API接口已发生变更，新的接口为***”。其中，具体的判断方法包括：将新上传的API文件的接口名称与API文件库16中存储的API文件的接口名称相比较，若新上传的API文件的接口名称与API文件库16中存储的某个API文件的接口名称相同，则判断该API文件是接口变更的已存储API 文件，若新上传的API文件的接口名称与API文件库16中存储的所有API 文件的接口名称不同，则判断该API文件是新增API文件。例如，新上传的API文件的API接口名称为人脸识别API接口，若API文件库16中同样存储人脸识别API接口，但新上传的API文件与API文件库16中存储API文件的API接口调用说明不同，则说明上传的API文件是接口变更的已存储API 文件；若API文件库16中没有存储人脸识别API接口，则说明上传的API 文件是新增的API文件。
假设上传的API文件是新增的API文件，API文件管理程序10为新增 API接口的API代码及API文件分配一个标签，通过标签建立API代码与API 文件之间的映射关系。其中，所述标签是根据标签列表17的顺序自动生成的一个唯一的标记名称，所述标签列表是指用于存储标签的文件。例如，新上传的年龄预测API接口文件为新增的API文件，标签列表中存储最大的标签号为标签022，则API文件管理程序10根据标签列表17按顺序自动生成一个标签023，并将标签023分配给年龄预测API接口的API代码和API文件，通过标签023建立起年龄预测API接口的API代码与API文件的映射关系。
API文件管理程序10设置该标签与客户端4地址之间的关联关系，为后续当该API文件中的接口变更时，发送提示接口变更的信息给客户端4。其中，所述客户端4指该API文件对应的API接口的调用方。例如，设置标签023 与客户端地址之间的关联关系，当后续年龄预测接口变更时，向客户端4发送接口变更提示信息，如“年龄预测API接口已发生变更，新的接口为***”。
上述实施例提出的API文件管理方法与rest风格的API文件管理方法、 markdown文件管理方法不同，rest风格的API文件是在代码中添加大量注释，即代码与API文件相结合，降低代码可读性；markdown文件与本文提及的 API文件都是代码与API文件相分离，但markdown文件需手动描述，markdown 文件的代码与API文件分别由后端、前端管理，API接口变更时更新不同步且多人协作的分离场景下表现较差，本文提及的API文件与代码均由后台管理，能够有效监控API接口的变更或新增，从而使得API接口变更时及时通知客户端4，避免代码入侵性。
可选地，在其他的实施例中，媒体文件处理程序10还可以被分割为一个或者多个模块，一个或者多个模块被存储于存储器11中，并由一个或多个处理器(本实施例为处理器12)所执行，以完成本发明。
如图3所示，是图1或图2中API文件管理程序10较佳实施例的模块示意图。本发明所称的模块是指能够完成特定功能的一系列计算机程序指令段。
在本实施例中，API文件管理程序10包括：接收模块110、判断模块120、分配模块130及设置模块140，所述模块110-140所实现的功能或操作步骤均与上文类似，此处不再详述，示例性地，例如其中：
接收模块110，用于接收服务端新上传的一份API文件；
判断模块120，用于根据API文件中的接口名称判断是接口变更的已存储 API文件，还是新增的API文件，若是接口变更的已存储API文件，则发送预设格式的提示信息给客户端、流程结束，若是新增的API文件，则流程进入分配步骤；
分配模块130，用于为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API文件之间的映射关系；
设置模块140，用于设置该标签与客户端地址之间的关联关系。
如图4所示，是本发明API文件管理方法较佳实施例的流程图。
在本实施例中，处理器12执行存储器11中存储的API文件管理程序10 的计算机程序时实现API文件管理方法包括步骤S10-S60：
步骤S10，当API文件管理程序10接收到服务端3新上传的一份API文件时，启动API文件管理程序10。其中，所述API文件是API接口的描述性文件，每个 API文件包括API文件接口名称和API接口调用说明，所述API接口调用说明包括API接口中的方法、类的功能、参数等相关说明。以人脸识别接口为例对本发明的方案进行解释，当接收到服务端3新上传一份关于人脸识别API接口的 API文件时，启动API文件管理程序10。所述服务端3指该API文件对应的API 接口的提供方。所述客户端4指该API文件对应的API接口的调用方。例如，服务端3提供人脸识别接口，客户端4调用人脸识别接口进行人脸识别应用。
步骤S20，API文件管理程序10通过上传的API文件的接口名称判断该API 文件是接口变更的已存储API文件，还是新增的API文件。
步骤S30，假设判断出上传的API文件是接口变更的已存储API文件，则执行步骤S40。假设判断出上传的API文件是新增的API文件，则执行步骤S50。其中，具体的判断方法包括：将新上传的API文件的接口名称与API文件库16 中存储的API文件的接口名称相比较，若新上传的API文件的接口名称与API 文件库16中存储的某个API文件的接口名称相同，则判断该API文件是接口变更的已存储API文件，若新上传的API文件的接口名称与API文件库16中存储的所有API文件的接口名称不同，则判断该API文件是新增API文件。例如，新上传的API文件的API接口名称为人脸识别API接口，若API文件库16中同样存储人脸识别API接口，但新上传的API文件与API文件库16中存储API文件的API 接口调用说明不同，则说明上传的API文件是接口变更的已存储API文件；若 API文件库16中没有存储人脸识别API接口，则说明上传的API文件是新增的 API文件。
步骤S40，API文件管理程序10发送预设格式的提示信息给客户端4。例如，通过上传的API文件的接口名称判断该API文件是人脸识别API接口变更的已存储的API文件，则向客户端4发送接口变更提示信息，如“人脸识别API接口已发生变更，新的接口为***”。
步骤S50，若上传的API文件是新增的API文件，API文件管理程序10为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API 文件之间的映射关系。其中，所述标签是根据标签列表17按顺序自动生成的一个唯一的标记名称。例如，新上传的年龄预测API接口文件为新增的API文件，标签列表中存储最大的标签号为标签022，则API文件管理程序10根据标签列表17按顺序自动生成一个标签023，并将标签023分配给年龄预测API接口的API代码和API文件，通过标签023建立起年龄预测API接口的API代码与API 文件的映射关系。
步骤S60，API文件管理程序10设置该标签与客户端地址之间的关联关系，为后续当该API文件中的接口变更时，发送提示接口变更的信息给客户端4。其中，所述客户端4指该API文件对应的API接口的调用方。例如，设置标签023与客户端地址之间的关联关系，当后续年龄预测接口变更时，向客户端4发送接口变更提示信息，如“年龄预测API接口已发生变更，新的接口为***”。
上述实施例提出的API文件管理方法，对服务端3上传的API进行判断，若是接口变更的API文件，则发送预设格式的提示信息给客户端4，若是新增的API文件，则分配一个标签并建立API代码与API文件之间的映射关系，再将该标签与客户端地址绑定，从而有效监控接口变更，能够及时通知客户端4，避免代码入侵性。
如图5所示，是本发明API文件管理方法第二实施例的流程图。
在本实施例中，处理器12执行存储器11中存储的API文件管理程序10 的计算机程序时实现API文件管理方法包括步骤S10-S70：
步骤S10，当API文件管理程序10接收到服务端3新上传的一份API文件时，启动API文件管理程序10。其中，所述API文件是API接口的描述性文件，每个 API文件包括API文件接口名称和API接口调用说明，所述API接口调用说明包括API接口中的方法、类的功能、参数等相关说明。以人脸识别项目为例对本发明的方案进行解释，当接收到服务端3新上传一份关于人脸识别API接口的 API文件时，启动API文件管理程序10。所述服务端3指该API文件对应的API 接口的提供方。所述客户端4指该API文件对应的API接口的调用方。例如，服务端3提供人脸识别接口，客户端4调用人脸识别接口进行人脸识别应用。
步骤S20，API文件管理程序10通过上传的API文件的接口名称判断该API 文件是接口变更的已存储API文件，还是新增的API文件。
步骤S30，假设判断出上传的API文件是接口变更的已存储API文件，则执行步骤S40。假设判断出上传的API文件是新增的API文件，则执行步骤S50。其中，具体的判断方法包括：将新上传的API文件的接口名称与API文件库16 中存储的API文件的接口名称相比较，若新上传的API文件的接口名称与API 文件库16中存储的某个API文件的接口名称相同，则判断该API文件是接口变更的已存储API文件，若新上传的API文件的接口名称与API文件库16中存储的所有API文件的接口名称不同，则判断该API文件是新增API文件。例如，新上传的API文件的API接口名称为人脸识别API接口，若API文件库16中同样存储人脸识别API接口，但新上传的API文件与API文件库16中存储API文件的API 接口调用说明不同，则说明上传的API文件是接口变更的已存储API文件；若 API文件库16中没有存储人脸识别API接口，则说明上传的API文件是新增的 API文件。
步骤S40，API文件管理程序10发送预设格式的提示信息给客户端4。例如，通过上传的API文件的接口名称判断该API文件是人脸识别API接口变更的已存储的API文件，则向客户端4发送接口变更提示信息，如“人脸识别API接口已发生变更，新的接口为***”。
步骤S50，若上传的API文件是新增的API文件，API文件管理程序10为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API 文件之间的映射关系。其中，所述标签是根据标签列表17按顺序自动生成的一个唯一的标记名称。例如，新上传的年龄预测API接口文件为新增的API文件，标签列表中存储最大的标签号为标签022，则API文件管理程序10根据标签列表17按顺序自动生成一个标签023，并将标签023分配给年龄预测API接口的API代码和API文件，通过标签023建立起年龄预测API接口的API代码与API 文件的映射关系。
步骤S60，API文件管理程序10设置该标签与客户端地址之间的关联关系，为后续当该API文件中的接口变更时，发送提示接口变更的信息给客户端4。其中，所述客户端地址可以是IP地址或邮箱。所述客户端4指该API 文件对应的API接口的调用方。例如，设置标签023与客户端地址之间的关联关系，当后续年龄预测接口变更时，向客户端4发送接口变更提示信息，如“年龄预测API接口已发生变更，新的接口为***”。
步骤S70，标签与客户端地址之间的关联关系设置完成后，API文件管理程序10发送预设格式的反馈信息给服务端3。其中，所述反馈信息可以通过邮箱或短信方式给服务端3。例如，标签与客户端地址之间的关联关系设置完成后，向服务端3的邮箱发送反馈信息，如“新增的年龄预测API接口对应的标签设置完毕”。
在另一个实施例中，还可以在分配步骤或设置步骤设置失败提示信息，用于在分配标签或设置标签与客户端地址关联关系失败时，向服务端3的邮箱发送预设格式的失败提示信息及失败原因。例如，设置标签与客户端地址关联关系失败时，向服务端3的邮箱发送反馈信息，如“新增的***API接口对应的标签设置失败，失败原因为***，请及时处理”或“新增的***API接口 ***失败，原因如下：***，请及时处理”。
相比于第一实施例，本实施例提出的API文件管理方法，在设置完标签与客户端地址之间的关联关系之后向服务端3发送反馈信息，提高对API文件管理的实时监控，使API文件更新失败时及时进行处理。
此外，本发明实施例还提出一种计算机可读存储介质，所述计算机可读存储介质中包括API文件管理程序10，所述API文件管理程序10被处理器执行时实现如下操作：
接收步骤：接收服务端新上传的一份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文件管理方法的具体实施方式大致相同，在此不再赘述。
上述本发明实施例序号仅仅为了描述，不代表实施例的优劣。
需要说明的是，在本文中，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、装置、物品或者方法不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、装置、物品或者方法所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括该要素的过程、装置、物品或者方法中还存在另外的相同要素。
通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到上述实施例方法可借助软件加必需的通用硬件平台的方式来实现，当然也可以通过硬件，但很多情况下前者是更佳的实施方式。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品存储在如上所述的一个存储介质(如ROM/RAM、磁碟、光盘)中，包括若干指令用以使得一台终端设备(可以是手机，计算机，服务器，或者网络设备等)执行本发明各个实施例所述的方法。
以上仅为本发明的优选实施例，并非因此限制本发明的专利范围，凡是利用本发明说明书及附图内容所作的等效结构或等效流程变换，或直接或间接运用在其它相关的技术领域，均同理包括在本发明的专利保护范围内。

Claims (10)

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.一种服务器，其特征在于，所述服务器包括：存储器、处理器及显示器，所述存储器上存储有API文件管理程序，所述API文件管理程序被所述处理器执行，可实现如下步骤：
接收步骤：接收服务端新上传的一份API文件；
判断步骤：根据API文件中的接口名称判断是接口变更的已存储API文件，还是新增的API文件，若是接口变更的已存储API文件，则发送预设格式的提示信息给客户端、流程结束，若是新增的API文件，则流程进入分配步骤；
分配步骤：为新增API接口的API代码及API文件分配一个标签，通过标签建立API代码与API文件之间的映射关系；
设置步骤：设置该标签与客户端地址之间的关联关系。
7.根据权利要求6所述的服务器，其特征在于，所述API文件管理程序被所述处理器执行，还实现如下步骤：在服务器中将API接口的代码与API文件进行分离，提供代码库存储API代码，API文件库存储API文件。
8.根据权利要求6所述的服务器，其特征在于，所述判断步骤还包括：
将新上传的API文件的接口名称与API文件库中存储的API文件的接口名称相比较，若新上传的API文件的接口名称与API文件库中存储的某个API文件的接口名称相同，则判断该API文件是接口变更的已存储API文件，若新上传的API文件的接口名称与API文件库中存储的所有API文件的接口名称不同，则判断该API文件是新增的API文件。
9.根据权利要求6所述的服务器，其特征在于，所述API文件管理程序被所述处理器执行，还实现如下步骤：标签与客户端地址之间的关联关系设置完成后，发送预设格式的反馈信息给服务端。
10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质中包括API文件管理程序，所述统API文件管理程序被处理器执行时，可实现如权利要求1至5中任一项所述API文件管理方法的步骤。
CN201810026284.XA 2018-01-11 2018-01-11 Api文件管理方法、服务器及存储介质 Pending CN108427560A (zh)

Priority Applications (2)

Application Number Priority Date Filing Date Title
CN201810026284.XA CN108427560A (zh) 2018-01-11 2018-01-11 Api文件管理方法、服务器及存储介质
PCT/CN2018/077655 WO2019136813A1 (zh) 2018-01-11 2018-02-28 Api文件管理方法、服务器及存储介质

Applications Claiming Priority (1)

Application Number Priority Date Filing Date Title
CN201810026284.XA CN108427560A (zh) 2018-01-11 2018-01-11 Api文件管理方法、服务器及存储介质

Publications (1)

Publication Number Publication Date
CN108427560A true CN108427560A (zh) 2018-08-21

Family

ID=63155881

Family Applications (1)

Application Number Title Priority Date Filing Date
CN201810026284.XA Pending CN108427560A (zh) 2018-01-11 2018-01-11 Api文件管理方法、服务器及存储介质

Country Status (2)

Country Link
CN (1) CN108427560A (zh)
WO (1) WO2019136813A1 (zh)

Cited By (3)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN109144501A (zh) * 2018-08-30 2019-01-04 杭州数澜科技有限公司 一种通过标签生成api的方法和***
CN109710301A (zh) * 2018-11-30 2019-05-03 福建天泉教育科技有限公司 一种自动比较接口文档差异的方法及终端
CN111198818A (zh) * 2019-12-30 2020-05-26 北京中网易企秀科技有限公司 一种信息获取方法及装置

Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US20090210861A1 (en) * 2008-02-20 2009-08-20 Mariana Alupului Dita doclet tool and method for extracting and analyzing api documentation
CN101814084A (zh) * 2010-01-11 2010-08-25 北京世纪高通科技有限公司 Api管理方法及***
CN103049271A (zh) * 2012-12-27 2013-04-17 微梦创科网络科技（中国）有限公司 自动生成api接口的描述文档的方法和装置
CN105045577A (zh) * 2015-06-29 2015-11-11 用友优普信息技术有限公司 接口变更的提示方法和接口变更的提示***

Family Cites Families (2)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN104484216B (zh) * 2014-12-29 2018-03-16 广州品唯软件有限公司 服务接口文档和在线测试工具生成方法、装置
CN107291459A (zh) * 2017-06-09 2017-10-24 深圳市金立通信设备有限公司 一种整理信息的方法及服务器

Patent Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US20090210861A1 (en) * 2008-02-20 2009-08-20 Mariana Alupului Dita doclet tool and method for extracting and analyzing api documentation
CN101814084A (zh) * 2010-01-11 2010-08-25 北京世纪高通科技有限公司 Api管理方法及***
CN103049271A (zh) * 2012-12-27 2013-04-17 微梦创科网络科技（中国）有限公司 自动生成api接口的描述文档的方法和装置
CN105045577A (zh) * 2015-06-29 2015-11-11 用友优普信息技术有限公司 接口变更的提示方法和接口变更的提示***

Cited By (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN109144501A (zh) * 2018-08-30 2019-01-04 杭州数澜科技有限公司 一种通过标签生成api的方法和***
CN109710301A (zh) * 2018-11-30 2019-05-03 福建天泉教育科技有限公司 一种自动比较接口文档差异的方法及终端
CN111198818A (zh) * 2019-12-30 2020-05-26 北京中网易企秀科技有限公司 一种信息获取方法及装置
CN111198818B (zh) * 2019-12-30 2023-02-24 北京中网易企秀科技有限公司 一种信息获取方法及装置

Also Published As

Publication number Publication date
WO2019136813A1 (zh) 2019-07-18

Similar Documents

Publication Publication Date Title
CN104704468B (zh) Web应用程序的跨***安装
CN112073994A (zh) 用于空中升级的方法、装置、电子设备及可读存储介质
CN104598513A (zh) 一种基于网页框架的数据流控制方法和***
CN110427252A (zh) 基于任务依赖关系的任务调度方法、装置及存储介质
US10439957B1 (en) Tenant-based management system and method for distributed computing environments
CN110740053A (zh) 业务编排方法及装置
CN108399072A (zh) 应用页面更新方法和装置
CN104978172A (zh) Sdn应用集成管理和控制的方法、***及设备
CN108427560A (zh) Api文件管理方法、服务器及存储介质
CN110738038A (zh) 合同文本的生成方法、装置、设备及计算机可读存储介质
CN111858007A (zh) 一种基于消息中间件的任务调度方法方法和装置
CN109726546A (zh) 一种权限管理方法及装置
CN106888264B (zh) 一种数据交换方法和装置
CN110532058B (zh) 容器集群服务的管理方法、装置、设备及可读存储介质
CN103561089B (zh) 虚拟机桌面登录方法、装置及***
JP6751778B2 (ja) 業務システムとマルチアセンブリーとのやりとりを実現する方法、電子装置及び記憶媒体
CN110187872A (zh) 一种bios开发方法、***及电子设备和存储介质
CN117114618A (zh) 待办项跟进方法、***、计算机设备及存储介质
CN102868746B (zh) 实现移动信息化的方法
CN110018866B (zh) 用户界面主题更新方法、装置、***、车机及车辆
CN103186405A (zh) 一种实现设备的统一控制方法和装置
CN110908644A (zh) 状态节点的配置方法、装置、计算机设备和存储介质
US20220342742A1 (en) Graphical management of big data pipelines
CN110765610A (zh) Pdm集成方法、装置、计算机设备及存储介质
CN109542841A (zh) 集群中创建数据快照的方法及终端设备

Legal Events

Date Code Title Description
PB01 Publication
PB01 Publication
SE01 Entry into force of request for substantive examination
SE01 Entry into force of request for substantive examination
RJ01 Rejection of invention patent application after publication
RJ01 Rejection of invention patent application after publication

Application publication date: 20180821