接口文档的处理方法及装置制造方法及图纸

本申请公开了一种接口文档的处理方法及装置，涉及互联网技术领域。所述方法包括：获取第一目标接口文档，所述第一目标接口文档包括多个接口；获取第一解析脚本；通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件；其中，所述第一目标解析文件包括与所述多个接口相对应的多个接口封装函数。通过所述接口文档处理方法可以大幅度地提高前端技术人员调用第一目标接口文档中接口的效率，从而解决现有技术中手动单个封装接口函数的效率不高的问题。的效率不高的问题。的效率不高的问题。

【技术实现步骤摘要】
接口文档的处理方法及装置


[0001]本申请涉及互联网
，尤其涉及一种接口文档的处理方法及装置。

技术介绍

[0002]随着互联网技术的发展，在互联网项目的开发中前后端分离已成为标准的使用方式，而前后端分离的核心思想是前端技术人员基于后端技术人员撰写的接口文档来调用接口，以进行数据交互。
[0003]目前，现有方案中将接口文档中的接口转化为可调用的接口封装函数，一般是由前端技术人员手动将接口文档中的每一个接口封装成独立的函数，存放于一个公共的文件中，供前端在使用时进行调用。
[0004]然而，在面对一个接口文档中包含大量接口的情况下，这种由前端技术人员手动单个封装接口函数的效率不高。

技术实现思路

[0005]本申请实施例提供一种接口文档的处理方法及装置，以解决现有技术中手动单个封装接口函数的效率不高的问题。
[0006]第一方面，本申请提供了一种接口文档的处理方法，所述方法包括：
[0007]获取第一目标接口文档，所述第一目标接口文档包括多个接口；
[0008]获取第一解析脚本；
[0009]通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件；
[0010]其中，所述第一目标解析文件包括与所述多个接口相对应的多个接口封装函数。
[0011]第二方面，本申请提供了一种接口文档的处理装置，所述装置包括：
[0012]获取模块，用于获取第一目标接口文档，所述第一目标接口文档包括多个接口；获取第一解析脚本；
>[0013]处理模块，用于通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件；
[0014]其中，所述第一目标解析文件包括与所述多个接口相对应的多个接口封装函数。
[0015]第三方面，本申请提供了一种服务器，包括：处理器，存储器及存储在所述存储器上并在所述处理器上运行的程序或指令，所述程序或指令被所述处理器执行时实现第一方面的方法的步骤。
[0016]第四方面，本申请提供了一种可读存储介质，所述可读存储介质上存储程序或指令，所述程序或指令被处理器执行时实现第一方面的方法的步骤。
[0017]本申请实施例采用的上述至少一个技术方案能够达到以下有益效果：
[0018]在本申请实施例中，获取第一目标接口文档，所述第一目标接口文档包括多个接口；获取第一解析脚本；通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件；其中，所述第一目标解析文件包括与所述多个接口相对应的多个接口封装函数。
如此，可以通过第一解析脚本对包括多个接口的第一目标接口文档进行自动化解析，得到包括与多个接口相对应的多个接口封装函数的第一目标解析文件，可以大幅度地提高前端技术人员调用第一目标接口文档中接口的效率，从而解决现有技术中手动单个封装接口函数的效率不高的问题。
附图说明
[0019]此处所说明的附图用来提供对本申请的进一步理解，构成本申请的一部分，本申请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：
[0020]图1为本申请实施例提供的一种接口文档的处理方法的流程图；
[0021]图2为本申请实施例提供的一种接口文档的处理方法的流程图；
[0022]图3为本申请实施例提供的一种接口文档的处理方法的流程图；
[0023]图4为本申请实施例提供的一种接口文档的处理方法的示意图；
[0024]图5为本申请实施例提供的一种接口文档的处理装置的结构框图；
[0025]图6为本申请实施例提供的一种服务器的结构框图。
具体实施方式
[0026]为使本申请的目的、技术方案和优点更加清楚，下面将结合本申请具体实施例及相应的附图对本申请技术方案进行清楚、完整地描述。显然，所描述的实施例仅是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。
[0027]本申请的说明书和权利要求书中的术语“第一”、“第二”等是用于区别类似的对象，而不用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便本申请的实施例能够以除了在这里图示或描述的那些以外的顺序实施，且“第一”、“第二”等所区分的对象通常为一类，并不限定对象的个数，例如第一对象可以是一个，也可以是多个。此外，说明书以及权利要求中“和/或”表示所连接对象的至少其中之一，字符“/”，一般表示前后关联对象是一种“或”的关系。
[0028]以下结合附图，详细说明本申请各实施例提供的技术方案。
[0029]本申请实施例提供的接口文档的处理方法可以由前端服务器执行。
[0030]图1是本申请实施例提供的一种接口文档的处理方法的流程图，参照图1，本申请实施例提供的接口文档的处理方法可以包括：
[0031]步骤110，获取第一目标接口文档，所述第一目标接口文档包括多个接口；
[0032]其中，所述第一目标接口文档可以为表示性状态转移应用程序编程接口(Representational State Transfer ApplicationProgramming Interface，RESTFUL API)文档；所述API接口文档中可以包括多个API接口。可以理解的是，所述第一目标接口文档可以为后端技术人员进行编写的，也就是说，前端服务器可以从后端服务器上获取所述第一目标接口文档。
[0033]在本申请实施例中，所述接口可以是一些预先定义的函数，或者可以指软件系统不同组成部分衔接的约定。接口的目的可以是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。所述接口可以
分为四部分：方法、统一资源定位器(Uniform Resource Locator，URL)、请求参数、返回参数。其中，URL是万维网的统一资源定位标志，也就是网络地址。URL可以由三部分组成：资源类型、存放资源的主机域名和资源文件名；也可以由四部分组成：协议、主机、端口和路径。
[0034]步骤120，获取第一解析脚本；
[0035]其中，所述第一解析脚本可以为用户预先配置的用于读取解析所述第一目标接口文档内容的脚本；所述第一解析脚本中可以包含自定义的解析规则。
[0036]需了解的是，步骤110与步骤120的顺序可以按照实际情况进行选择，在此不做限定。举例而言，可以先进行步骤110，再进行步骤120；也可以先进行步骤120，再进行步骤110；还可以步骤110和步骤120同时进行。
[0037]步骤130，通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件。
[0038]可以理解的是，通过所述第一解析脚本解析所述第一目标接口文档的过程可以是由前端服务器执行指令进行自动解析的过程。具体地，在本申请实施例中，可以在前端服务本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档的处理方法，其特征在于，所述方法包括：获取第一目标接口文档，所述第一目标接口文档包括多个接口；获取第一解析脚本；通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件；其中，所述第一目标解析文件包括与所述多个接口相对应的多个接口封装函数。2.根据权利要求1所述的处理方法，其特征在于，所述通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件包括：通过所述第一解析脚本读取所述第一目标接口文档中的所述多个接口；将所述多个接口转换成与所述多个接口对应的所述多个接口封装函数；将所述多个接口封装函数输出到指定文件中，并将所述指定文件作为所述第一目标解析文件。3.根据权利要求1所述的处理方法，其特征在于，所述第一目标解析文件还包括多个错误回调函数，所述多个错误回调函数中的一个错误回调函数与所述多个接口封装函数中的一个接口封装函数相对应；所述通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件包括：通过所述第一解析脚本读取所述第一目标接口文档中的所述多个接口；将所述多个接口转换成与所述多个接口对应的所述多个接口封装函数；针对所述多个接口封装函数中的每一个接口封装函数添加所述错误回调函数；将所述多个接口封装函数和与所述多个接口封装函数对应的所述多个错误回调函数输出到指定文件中，并将所述指定文件作为所述第一目标解析文件。4.根据权利要求3所述的处理方法，其特征在于，在所述通过所述第一解析脚本解析所述第一目标接口文档，得到第一目标解析文件之后，所述方法还包括：在所述多个接口封装函数中的目标接口封装函数出现运行错误的情况下，通过所述错误回调函数向后端装置反馈错误信息。5.根据权利要求4所述的处理方法，其特征在于，在所述通过所述错误回调函数向后端装置反馈错误信息之后，所述方法还包括：接收所述后端装置发送的第二目标接口文档，所述第二目标接口文档为对所述第一目标接口...

【专利技术属性】
技术研发人员：王文彦，高瞻，洪国栋，霍伟伟，周潇，李金铭，
申请(专利权)人：北京世纪互联宽带数据中心有限公司，
类型：发明
国别省市：