CN115086436B - Api间参数校验方法、装置、计算机设备及存储介质 - Google Patents
Api间参数校验方法、装置、计算机设备及存储介质 Download PDFInfo
- Publication number
- CN115086436B CN115086436B CN202210686333.9A CN202210686333A CN115086436B CN 115086436 B CN115086436 B CN 115086436B CN 202210686333 A CN202210686333 A CN 202210686333A CN 115086436 B CN115086436 B CN 115086436B
- Authority
- CN
- China
- Prior art keywords
- interface
- api
- message
- parameter
- field
- 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.)
- Active
Links
Images
Classifications
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
- H04L41/00—Arrangements for maintenance, administration or management of data switching networks, e.g. of packet switching networks
- H04L41/08—Configuration management of networks or network elements
- H04L41/0803—Configuration setting
- H04L41/0813—Configuration setting characterised by the conditions triggering a change of settings
- H04L41/0816—Configuration setting characterised by the conditions triggering a change of settings the condition being an adaptation, e.g. in response to network events
-
- Y—GENERAL TAGGING OF NEW TECHNOLOGICAL DEVELOPMENTS; GENERAL TAGGING OF CROSS-SECTIONAL TECHNOLOGIES SPANNING OVER SEVERAL SECTIONS OF THE IPC; TECHNICAL SUBJECTS COVERED BY FORMER USPC CROSS-REFERENCE ART COLLECTIONS [XRACs] AND DIGESTS
- Y02—TECHNOLOGIES OR APPLICATIONS FOR MITIGATION OR ADAPTATION AGAINST CLIMATE CHANGE
- Y02D—CLIMATE CHANGE MITIGATION TECHNOLOGIES IN INFORMATION AND COMMUNICATION TECHNOLOGIES [ICT], I.E. INFORMATION AND COMMUNICATION TECHNOLOGIES AIMING AT THE REDUCTION OF THEIR OWN ENERGY USE
- Y02D10/00—Energy efficient computing, e.g. low power processors, power management or thermal management
Landscapes
- Engineering & Computer Science (AREA)
- Computer Networks & Wireless Communication (AREA)
- Signal Processing (AREA)
- Debugging And Monitoring (AREA)
Abstract
本申请提供一种AP I间参数校验方法、装置、计算机设备及存储介质,其中,一种AP I间参数校验方法包括:接收开发者所在开发终端发送的接口调用请求时;基于接口配置信息判断接口参数是否满足预设条件,若接口参数不满足预设条件,则生成错误提示的报文;向开发终端发送针对接口调用请求的响应信息,以使得开发终端在响应信息携带错误提示的报文时,根据错误提示的报文修改接口参数,并基于修改后的接口参数重新发送接口调用请求。本申请能够自动对AP I的参数进行校验,以确保多个AP I参数一致,其中,由于本申请能够自动对AP I的参数进行校验,而不需要人工参与AP I的参数校验,因此本申请具有AP I的参数校验效率高的优点。
Description
技术领域
本申请涉及计算机技术领域,具体而言,涉及一种API间参数校验方法、装置、计算机设备及存储介质。
背景技术
API联调是开发者和开放平台API对接不可或缺的一个步骤,目前,在复杂的API调用流程中,多个API间的参数存在一致性依赖,例如用户开通银行账户的流程中,需要用上传影像API上传用户的身份证,然后调用影像审核API进行影像审核,调用影像审核API的时候要把上传影像API返回的文件ID作为入参上传。
在上述过程中,如果多个API之间的参数没有按照一致性依赖传值,则开放平台的技术支持人员,需要查日志,找到几个有参数依赖关系的API的参数,根据API间的依赖关系用肉眼检查,找到参数错误以后告知开发者传值错误,并指导开发者按照正确的规则传值,其中,一个此种类型的错误从发生到解决,大概需要20-30分钟时间,因此这种解决问题的方式存在两个主要问题:
1、开发者长时间等待,体验极差。(如果有两个开发者遇见此类问题同时咨询开放平台的一个技术支持人员,就有一个开发者至少等待40分钟,以此类推)
2、开放平台技术支持人员的人力消耗很大。
发明内容
本申请的目的在于提供一种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是本申请实施例一公开的一种API间参数校验方法的流程示意图;
图2是本申请实施例二公开的一种API间参数校验方法的流程示意图;
图3是本申请实施例三公开的一种API间参数校验装置的结构示意图;
图4是本申请实施例四公开的一种API间参数校验装置的结构示意图;
图5是本申请实施例五公开的一种计算机设备的结构示意图。
具体实施方式
下面将结合本申请实施例中的附图,对本申请实施例中的技术方案进行描述。
实施例一
请参阅图1,图1是本申请实施例公开的一种API间参数校验方法的流程示意图,其中,该方法应用于联调平台。如图1所示,本申请实施例的方法包括以下步骤:
101、接收开发者所在开发终端发送的接口调用请求时,其中,接口调用请求携带接口参数;
102、基于接口配置信息判断接口参数是否满足预设条件,若接口参数满足预设条件,则生成携带正确业务报文,若接口参数不满足预设条件,则生成错误提示的报文,其中,错误提示包括针对接口参数的修改提示信息;
103、向开发终端发送针对接口调用请求的响应信息,以使得开发终端在响应信息携带错误提示的报文时,根据错误提示的报文修改接口参数,并基于修改后的接口参数重新发送接口调用请求。
在本申请实施例中,针对步骤101,开发者所在开发终端可以是移动终端,也可以PC终端。
在本申请实施例中,针对步骤101,接口是指api接口,即API(ApplicationProgram Interface,应用程序接口),其中,应用程序接口是一组定义、程序及协议的集合,通过API接口实现计算机软件之间的相互通信。
在本申请实施例中,针对步骤102,接口调用请求是针对目标API发起,其中,目标API与其他API存在关联,例如假设存在第一API和第二API,则,第一API和第二API同时使用到字段A,则第一API和第二API存在关联,故第一API和第二API均可以是目标API。
在本申请实施例中,针对步骤102,由于联调平台与开发终端通过报文的形式进行通信,因此需要生成报文。
在本申请实施例中,针对步骤102,正确业务报文是指接口参数中所携带的接口参数正确,即接口参数与其关联的API中的参数一致,例如,假设存在第一API和第二API,其中,第一API具有文件地址字段classaddr,且classaddr://d/test.jpg,而第二API需要调用第一API中的文件地址字段的内容,因此,在联调平台在获取到针对第一API的接口参数时,判断,该接口参数中携带文件地址的字段是否为“classaddr”,如果是则确定该接口参数满足预设条件,如果不是,则确定该接口参数不满足预设条件。
在本申请实施例中,针对步骤102,错误提示用于提示开发终端上传的接口参数需要修改,并提示开发终端修改的具体内容,例如,如果接口参数中的文件地址字段不是“classaddr”,而是“addr”时,则错误提示用于提示将文件地址字段修改为“classaddr”。
本申请实施例的方法通过接口配置信息自动判断接口参数是否满足预设条件,若接口参数满足预设条件,则生成携带正确业务报文,若接口参数不满足预设条件,则生成错误提示的报文,其中,错误提示包括针对接口参数的修改提示信息。另一方面,本申请能够使联调平台向开发终端发送针对接口调用请求的响应信息,以使得开发终端在响应信息携带错误提示的报文时,根据错误提示的报文修改接口参数,并基于修改后的接口参数重新发送接口调用请求。
通过上述过程,本申请实施例能够自动对API的参数进行校验,而不需要人工参与API的参数校验,因此本申请具有API的参数校验效率高的优点。例如,在开发终端联调过程中,如果没有按照一致性依赖关系传递参数,通过联调平台得响应可以实时获得明确提示,直接可以根据提示修改代码,并继续下面的联调,不需要长时间等待平台的对接人员排查问题,相对于传统的解决此类问题的方式,开发者体验大大提高,并且开放平台的对接人员的人力消耗大大减小,即避免花费20-30分钟处理该问题。
在本申请实施例中,作为一种可选的实施方式,在步骤102:基于接口配置信息判断接口参数是否满足预设条件之前,本申请实施例的方法还包括以下步骤:
接收接口配置信息,其中,接口配置信息包括被校验字段、参考步骤、参考API、参考字段类型、参考字段;
保存接口配置信息。
在本可选的实施方式中,进一步可选地,接口配置信息以数据表的形式保存在联调平台的数据库中,例如,接口配置信息以数据表的形式保存在联调平台的Oracle数据库。
在本可选的实施方式中,参考步骤用于指示开发终端按照预设步骤所指定的参数进行传输,在一些场景中,第二API调用第一API时,第二API会调用API所实现的功能A,或者调用API所实现的功能B,因此,需要告知开发终端上传的参数还需要与具体步骤对应。
例如,第二API会调用API所实现的功能A时,告知开发终端上传针对第一API的参数应当与功能A要求的参数一致,使得第二API能够以预定的字段正确调用第一API,而第二API会调用API所实现的功能B时,告知开发终端上传针对第一API的参数应当与功能B要求的参数一致,使得第二API能够以预定的字段正确调用第一API。
在本可选的实施方式中,被校验字段表示需要检验的字段,例如,当第二API需要调用第一API,从而拿到第一API计算得到的文件地址时,则针对第一API的接口参数中的与文件地址相关的字段为被校验字段。
在本可选的实施方式中,参考API表示当前API需要对应的对象,例如,当开发终端上传了针对第一API的接口参数时,该第一API的接口参数需要与第二API要求的参数一致,则在这个过程中,第二API为参考API。
需要说明的是,开发终端上次的针对第一API的接口参数是在开发终端的测试过程中发生,例如,为了实现在后续使用过程中,确保第一API和第二API能够正常联调,则开发终端会模拟调用第一API的过程。
在本可选的实施方式中,参考字段类型、参考字段依次表示接口参数中的字段比较的对象和属性,例如,当接口参数中的文件地址字段为需要校验时,则将参考字段与该文件地址字段进行比较,和将该文件地址字段的字段类型与参考字段类型进行比较。
在本可选的实施方式,作为一个具体示例,接口配置信息如表1所示,其中,假设当前步骤为3,当前API为apicode1。
被校验字段 | 参考步骤 | 参考API | 参考字段类型 | 参考字段 |
字段名1 | 1 | apicode2 | 入参 | 字段名5 |
字段名2 | 1 | apicode2 | 入参 | 字段名6 |
字段名3 | 2 | apicode3 | 入参 | 字段名7 |
字段名4 | 2 | apicode3 | 出参 | 字段名8 |
表1
如表1所示,apicode1中的字段名1需要与apicode2中的字段名5对应。
由上可知,本可选的实施方式通过接收接口配置信息,进而能够保持用于判断接口参数是否满足预设条件的接口配置信息。
在本申请实施例中,作为一种可选的实施方式,接口参数包括目标API名称、访问字段,相应地,步骤102:基于接口配置信息判断接口参数是否满足预设条件,若接口参数满足预设条件,则生成正确业务报文,若接口参数不满足预设条件,则生成错误提示的报文,包括以下子步骤:
基于目标API名称确定被校验字段;
判断被校验字段与访问字段是否相同,若相同,则生成正确业务报文,若不相同,则生成错误提示的报文。
本可选的实施方式通过目标API名称可确定被校验字段,进而能够判断被校验字段与访问字段是否相同,若相同,则生成正确业务报文,若不相同,则生成错误提示的报文。
在本申请实施例中,作为一种可选的实施方式,在步骤:判断被校验字段与访问字段是否相同之后,步骤:生成正确业务报文之前,本申请实施例的方法还包括以下步骤:
确定被校验字段的字段类型;
基于被校验字段的字段类型判断访问字段的字段类型是否一致,若不一致,则生成错误提示的报文。
本可选的实施方式通过确定被校验字段的字段类型,进而能够基于被校验字段的字段类型判断访问字段的字段类型是否一致,若不一致,则生成错误提示的报文。
在本申请实施例中,作为一种可选的实施方式,步骤:生成错误提示的报文,包括:
基于参考步骤、参考API、参考字段类型和参考字段生成误提示的报文。
本可选的实施方式基于参考步骤、参考API、参考字段类型和参考字段能够生成误提示的报文。
在本申请实施例中,作为一种可选的实施方式,步骤:基于目标API名称确定被校验字段,包括以下子步骤:
基于目标API名称确定参考API;
基于参考API确定被校验字段。
本可选的实施方式基于目标API名称能够确定参考API,进而能够基于参考API确定被校验字段。
实施例二
请参阅图2,图2是本申请实施例公开的一种API间参数校验方法的流程示意图,其中,该方法应用于开发终端。如图1所示,本申请实施例的方法包括以下步骤:
201、向联调平台发送接口调用请求,其中,接口调用请求携带接口参数,以使得联调平台判断接口参数是否满足预设条件并返回针对接口调用请求的响应信息;
202、当响应信息携带错误提示的报文时,根据错误提示的报文修改接口参数,并基于修改后的接口参数重新发送接口调用请求。
本申请实施例的方法能够自动对API的参数进行校验,而不需要人工参与API的参数校验,因此本申请具有API的参数校验效率高的优点。例如,在开发终端联调过程中,如果没有按照一致性依赖关系传递参数,通过联调平台得响应可以实时获得明确提示,直接可以根据提示修改代码,并继续下面的联调,不需要长时间等待平台的对接人员排查问题,相对于传统的解决此类问题的方式,开发者体验大大提高,并且开放平台的对接人员的人力消耗大大减小,即避免花费20-30分钟处理该问题。
实施例三
请参阅图3,图3是本申请实施例公开的一种API间参数校验装置的结构示意图,其中,该装置应用于联调平台。如图3所示,本申请实施例的装置包括以下功能模块:
接收模块301,用于接收开发者所在开发终端发送的接口调用请求时,其中,接口调用请求携带接口参数;
第一判断模块302,用于基于接口配置信息判断接口参数是否满足预设条件,若接口参数满足预设条件,则生成携带正确业务报文,若接口参数不满足预设条件,则生成错误提示的报文,其中,错误提示包括针对接口参数的修改提示信息;
第一发送模块303,用于向开发终端发送针对接口调用请求的响应信息,以使得开发终端在响应信息携带错误提示的报文时,根据错误提示的报文修改接口参数,并基于修改后的接口参数重新发送接口调用请求。
在本申请实施例中,针对步骤101,开发者所在开发终端可以是移动终端,也可以PC终端。
在本申请实施例中,接收模块301,接口是指api接口,即API(ApplicationProgram Interface,应用程序接口),其中,应用程序接口是一组定义、程序及协议的集合,通过API接口实现计算机软件之间的相互通信。
在本申请实施例中,第一判断模块302,接口调用请求是针对目标API发起,其中,目标API与其他API存在关联,例如假设存在第一API和第二API,则,第一API和第二API同时使用到字段A,则第一API和第二API存在关联,故第一API和第二API均可以是目标API。
在本申请实施例中,第一判断模块302,由于联调平台与开发终端通过报文的形式进行通信,因此需要生成报文。
在本申请实施例中,第一判断模块302,正确业务报文是指接口参数中所携带的接口参数正确,即接口参数与其关联的API中的参数一致,例如,假设存在第一API和第二API,其中,第一API具有文件地址字段classaddr,且classaddr://d/test.jpg,而第二API需要调用第一API中的文件地址字段的内容,因此,在联调平台在获取到针对第一API的接口参数时,判断,该接口参数中携带文件地址的字段是否为“classaddr”,如果是则确定该接口参数满足预设条件,如果不是,则确定该接口参数不满足预设条件。
在本申请实施例中,第一判断模块302,错误提示用于提示开发终端上传的接口参数需要修改,并提示开发终端修改的具体内容,例如,如果接口参数中的文件地址字段不是“classaddr”,而是“addr”时,则错误提示用于提示将文件地址字段修改为“classaddr”。
本申请实施例的方法通过接口配置信息自动判断接口参数是否满足预设条件,若接口参数满足预设条件,则生成携带正确业务报文,若接口参数不满足预设条件,则生成错误提示的报文,其中,错误提示包括针对接口参数的修改提示信息。另一方面,本申请能够使联调平台向开发终端发送针对接口调用请求的响应信息,以使得开发终端在响应信息携带错误提示的报文时,根据错误提示的报文修改接口参数,并基于修改后的接口参数重新发送接口调用请求。
通过上述过程,本申请实施例能够自动对API的参数进行校验,而不需要人工参与API的参数校验,因此本申请具有API的参数校验效率高的优点。例如,在开发终端联调过程中,如果没有按照一致性依赖关系传递参数,通过联调平台得响应可以实时获得明确提示,直接可以根据提示修改代码,并继续下面的联调,不需要长时间等待平台的对接人员排查问题,相对于传统的解决此类问题的方式,开发者体验大大提高,并且开放平台的对接人员的人力消耗大大减小,即避免花费20-30分钟处理该问题。
在本申请实施例中,作为一种可选的实施方式,本申请实施例的装置还包括保存模块,其中:
接收模块301,还用于接收接口配置信息,其中,接口配置信息包括被校验字段、参考步骤、参考API、参考字段类型、参考字段;
保存模块,还用于保存接口配置信息。
在本可选的实施方式中,进一步可选地,接口配置信息以数据表的形式保存在联调平台的数据库中,例如,接口配置信息以数据表的形式保存在联调平台的Oracle数据库。
在本可选的实施方式中,参考步骤用于指示开发终端按照预设步骤所指定的参数进行传输,在一些场景中,第二API调用第一API时,第二API会调用API所实现的功能A,或者调用API所实现的功能B,因此,需要告知开发终端上传的参数还需要与具体步骤对应。
例如,第二API会调用API所实现的功能A时,告知开发终端上传针对第一API的参数应当与功能A要求的参数一致,使得第二API能够以预定的字段正确调用第一API,而第二API会调用API所实现的功能B时,告知开发终端上传针对第一API的参数应当与功能B要求的参数一致,使得第二API能够以预定的字段正确调用第一API。
在本可选的实施方式中,被校验字段表示需要检验的字段,例如,当第二API需要调用第一API,从而拿到第一API计算得到的文件地址时,则针对第一API的接口参数中的与文件地址相关的字段为被校验字段。
在本可选的实施方式中,参考API表示当前API需要对应的对象,例如,当开发终端上传了针对第一API的接口参数时,该第一API的接口参数需要与第二API要求的参数一致,则在这个过程中,第二API为参考API。
需要说明的是,开发终端上次的针对第一API的接口参数是在开发终端的测试过程中发生,例如,为了实现在后续使用过程中,确保第一API和第二API能够正常联调,则开发终端会模拟调用第一API的过程。
在本可选的实施方式中,参考字段类型、参考字段依次表示接口参数中的字段比较的对象和属性,例如,当接口参数中的文件地址字段为需要校验时,则将参考字段与该文件地址字段进行比较,和将该文件地址字段的字段类型与参考字段类型进行比较。
在本可选的实施方式,作为一个具体示例,接口配置信息如表1所示,其中,假设当前步骤为3,当前API为apicode1。
被校验字段 | 参考步骤 | 参考API | 参考字段类型 | 参考字段 |
字段名1 | 1 | apicode2 | 入参 | 字段名5 |
字段名2 | 1 | apicode2 | 入参 | 字段名6 |
字段名3 | 2 | apicode3 | 入参 | 字段名7 |
字段名4 | 2 | apicode3 | 出参 | 字段名8 |
表1
如表1所示,apicode1中的字段名1需要与apicode2中的字段名5对应。
由上可知,本可选的实施方式通过接收接口配置信息,进而能够保持用于判断接口参数是否满足预设条件的接口配置信息。
在本申请实施例中,作为一种可选的实施方式,接口参数包括目标API名称、访问字段,相应地,第一判断模块302包括:
第一确定子模块,用于基于目标API名称确定被校验字段;
判断子模块,用于判断被校验字段与访问字段是否相同,若相同,则生成正确业务报文,若不相同,则生成错误提示的报文。
本可选的实施方式通过目标API名称可确定被校验字段,进而能够判断被校验字段与访问字段是否相同,若相同,则生成正确业务报文,若不相同,则生成错误提示的报文。
在本申请实施例中,作为一种可选的实施方式,本申请实施例的装置还包括以下功能模块:
确定模块,用于确定被校验字段的字段类型;
第二判断模块,用于基于被校验字段的字段类型判断访问字段的字段类型是否一致,若不一致,则生成错误提示的报文。
本可选的实施方式,通过确定被校验字段的字段类型,进而能够基于被校验字段的字段类型判断访问字段的字段类型是否一致,若不一致,则生成错误提示的报文。
在本申请实施例中,作为一种可选的实施方式,第二判断模块包括:
生成子模块,用于基于参考步骤、参考API、参考字段类型和参考字段生成误提示的报文。
本可选的实施方式基于参考步骤、参考API、参考字段类型和参考字段能够生成误提示的报文。
在本申请实施例中,作为一种可选的实施方式,生成子模块包括:
第二确定子模块,用于基于目标API名称确定参考API;
第三确定子模块,用于基于参考API确定被校验字段。
本可选的实施方式基于目标API名称能够确定参考API,进而能够基于参考API确定被校验字段。
实施例四
请参阅图4,图4是本申请实施例公开的一种API间参数校验装置的结构示意图,其中,该装置应用于开发终端。如图4所示,本申请实施例的装置包括以下功能模块:
第二发送模块401,用于向联调平台发送接口调用请求,其中,接口调用请求携带接口参数,以使得联调平台判断接口参数是否满足预设条件并返回针对接口调用请求的响应信息;
修改模块402,用于当响应信息携带错误提示的报文时,根据错误提示的报文修改接口参数,并触发第二发送模块401基于修改后的接口参数重新发送接口调用请求。
本申请实施例的装置通过执行API间参数校验方法,进而能够自动对API的参数进行校验,而不需要人工参与API的参数校验,因此本申请具有API的参数校验效率高的优点。例如,在开发终端联调过程中,如果没有按照一致性依赖关系传递参数,通过联调平台得响应可以实时获得明确提示,直接可以根据提示修改代码,并继续下面的联调,不需要长时间等待平台的对接人员排查问题,相对于传统的解决此类问题的方式,开发者体验大大提高,并且开放平台的对接人员的人力消耗大大减小,即避免花费20-30分钟处理该问题。
实施例五
请参阅图5,图5是本申请实施例公开的一种计算机设备的结构示意图。如图5所示,本申请实施例的计算机设备包括:
处理器502;以及
存储器501,配置用于存储机器可读指令,指令在由处理器502执行时,执行本申请实施例一的API间参数校验方法。
本申请实施例的计算机设备通过执行API间参数校验方法,进而能够自动对API的参数进行校验,而不需要人工参与API的参数校验,因此本申请具有API的参数校验效率高的优点。例如,在开发终端联调过程中,如果没有按照一致性依赖关系传递参数,通过联调平台得响应可以实时获得明确提示,直接可以根据提示修改代码,并继续下面的联调,不需要长时间等待平台的对接人员排查问题,相对于传统的解决此类问题的方式,开发者体验大大提高,并且开放平台的对接人员的人力消耗大大减小,即避免花费20-30分钟处理该问题。
实施例六
本申请实施例公开一种存储介质,存储介质存储有计算机程序,计算机程序被处理器执行本申请实施例一的API间参数校验方法。
本申请实施例的存储介质通过执行API间参数校验方法,进而能够自动对API的参数进行校验,而不需要人工参与API的参数校验,因此本申请具有API的参数校验效率高的优点。例如,在开发终端联调过程中,如果没有按照一致性依赖关系传递参数,通过联调平台得响应可以实时获得明确提示,直接可以根据提示修改代码,并继续下面的联调,不需要长时间等待平台的对接人员排查问题,相对于传统的解决此类问题的方式,开发者体验大大提高,并且开放平台的对接人员的人力消耗大大减小,即避免花费20-30分钟处理该问题。
在本申请所提供的实施例中,应该理解到,所揭露装置和方法,可以通过其它的方式实现。以上所描述的装置实施例仅仅是示意性的,例如,单元的划分,仅仅为一种逻辑功能划分,实际实现时可以有另外的划分方式,又例如,多个单元或组件可以结合或者可以集成到另一个***,或一些特征可以忽略,或不执行。另一点,所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些通信接口,装置或单元的间接耦合或通信连接,可以是电性,机械或其它的形式。
另外,作为分离部件说明的单元可以是或者也可以不是物理上分开的,作为单元显示的部件可以是或者也可以不是物理单元,即可以位于一个地方,或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。
再者,在本申请各个实施例中的各功能模块可以集成在一起形成一个独立的部分,也可以是各个模块单独存在,也可以两个或两个以上模块集成形成一个独立的部分。
需要说明的是,功能如果以软件功能模块的形式实现并作为独立的产品销售或使用时,可以存储在一个计算机可读取存储介质中。基于这样的理解,本申请的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来,该计算机软件产品存储在一个存储介质中,包括若干指令用以使得一台计算机设备(可以是个人计算机,服务器,或者网络设备等)执行本申请各个实施例所述方法的全部或部分步骤。而前述的存储介质包括:U盘、移动硬盘、只读存储器(Read-Only Memory,ROM)随机存取存储器(Random Access Memory,RAM)、磁碟或者光盘等各种可以存储程序代码的介质。
在本文中,诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来,而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。
以上所述仅为本申请的实施例而已,并不用于限制本申请的保护范围,对于本领域的技术人员来说,本申请可以有各种更改和变化。凡在本申请的精神和原则之内,所作的任何修改、等同替换、改进等,均应包含在本申请的保护范围之内。
Claims (9)
1.一种API间参数校验方法,其特征在于,所述方法应用于联调平台,所述方法包括:
接收开发者所在开发终端发送的接口调用请求时,其中,所述接口调用请求携带接口参数;
基于接口配置信息判断所述接口参数是否满足预设条件,若所述接口参数满足所述预设条件,则生成携带正确业务报文,若所述接口参数不满足所述预设条件,则生成错误提示的报文,其中,所述错误提示包括针对所述接口参数的修改提示信息;
向所述开发终端发送针对所述接口调用请求的响应信息,以使得所述开发终端在所述响应信息携带所述错误提示的报文时,根据所述错误提示的报文修改所述接口参数,并基于修改后的所述接口参数重新发送所述接口调用请求;
以及,在所述基于接口配置信息判断所述接口参数是否满足预设条件之前,所述方法还包括:
接收所述接口配置信息,其中,所述接口配置信息包括被校验字段、参考步骤、参考API、参考字段类型、参考字段;
保存所述接口配置信息。
2.如权利要求1所述的方法,其特征在于,所述接口参数包括目标API名称、访问字段;
以及,所述基于接口配置信息判断所述接口参数是否满足预设条件,若所述接口参数满足所述预设条件,则生成正确业务报文,若所述接口参数不满足所述预设条件,则生成错误提示的报文,包括:
基于所述目标API名称确定所述被校验字段;
判断所述被校验字段与所述访问字段是否相同,若相同,则生成所述正确业务报文,若不相同,则生成所述错误提示的报文。
3.如权利要求2所述的方法,其特征在于,在所述判断所述被校验字段与所述访问字段是否相同之后,所述生成所述正确业务报文之前,所述方法还包括:
确定所述被校验字段的字段类型;
基于所述被校验字段的字段类型判断所述访问字段的字段类型是否一致,若不一致,则生成所述错误提示的报文。
4.如权利要求2所述的方法,其特征在于,所述生成所述错误提示的报文,包括:
基于所述参考步骤、所述参考API、所述参考字段类型和所述参考字段生成所述误提示的报文。
5.如权利要求2所述的方法,其特征在于,所述基于所述目标API名称确定所述被校验字段,包括:
基于所述目标API名称确定所述参考API;
基于所述参考API确定所述被校验字段。
6.一种API间参数校验方法,其特征在于,所述方法应用于开发终端,所述方法包括:
向联调平台发送接口调用请求,其中,所述接口调用请求携带接口参数,以使得所述联调平台判断所述接口参数是否满足预设条件并返回针对所述接口调用请求的响应信息;
当所述响应信息携带错误提示的报文时,根据所述错误提示的报文修改所述接口参数,并基于修改后的所述接口参数重新发送所述接口调用请求;
以及,所述方法还包括:
发送接口配置信息,以使得所述联调平台在执行基于接口配置信息判断所述接口参数是否满足预设条件之前,接收所述接口配置信息并保存所述接口配置信息,其中,所述接口配置信息包括被校验字段、参考步骤、参考API、参考字段类型、参考字段。
7.一种API间参数校验装置,其特征在于,所述装置应用于联调平台,所述装置包括:
接收模块,用于接收开发者所在开发终端发送的接口调用请求时,其中,所述接口调用请求携带接口参数;
第一判断模块,用于基于接口配置信息判断所述接口参数是否满足预设条件,若所述接口参数满足所述预设条件,则生成携带正确业务报文,若所述接口参数不满足所述预设条件,则生成错误提示的报文,其中,所述错误提示包括针对所述接口参数的修改提示信息;
第一发送模块,用于向所述开发终端发送针对所述接口调用请求的响应信息,以使得所述开发终端在所述响应信息携带所述错误提示的报文时,根据所述错误提示的报文修改所述接口参数,并基于修改后的所述接口参数重新发送所述接口调用请求;
以及,所述装置还用于在所述基于接口配置信息判断所述接口参数是否满足预设条件之前,执行接收所述接口配置信息并保存所述接口配置信息,其中,所述接口配置信息包括被校验字段、参考步骤、参考API、参考字段类型、参考字段。
8.一种计算机设备,其特征在于,包括:
处理器;以及
存储器,配置用于存储机器可读指令,所述指令在由所述处理器执行时,执行如权利要求1-6任一项所述的API间参数校验方法。
9.一种存储介质,其特征在于,所述存储介质存储有计算机程序,所述计算机程序被处理器执行如权利要求1-6任一项所述的API间参数校验方法。
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202210686333.9A CN115086436B (zh) | 2022-06-16 | 2022-06-16 | Api间参数校验方法、装置、计算机设备及存储介质 |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202210686333.9A CN115086436B (zh) | 2022-06-16 | 2022-06-16 | Api间参数校验方法、装置、计算机设备及存储介质 |
Publications (2)
Publication Number | Publication Date |
---|---|
CN115086436A CN115086436A (zh) | 2022-09-20 |
CN115086436B true CN115086436B (zh) | 2023-05-26 |
Family
ID=83254451
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
CN202210686333.9A Active CN115086436B (zh) | 2022-06-16 | 2022-06-16 | Api间参数校验方法、装置、计算机设备及存储介质 |
Country Status (1)
Country | Link |
---|---|
CN (1) | CN115086436B (zh) |
Citations (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN108089985A (zh) * | 2017-12-14 | 2018-05-29 | 中国平安人寿保险股份有限公司 | 接口返回参数的校验方法、装置、设备及可读存储介质 |
CN112650488A (zh) * | 2019-10-12 | 2021-04-13 | 上海际链网络科技有限公司 | 参数校验方法及装置、存储介质、服务终端 |
Family Cites Families (6)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN110908890A (zh) * | 2018-09-18 | 2020-03-24 | 亿阳信通股份有限公司 | 一种接口的自动测试方法和装置 |
CN111190596A (zh) * | 2019-12-24 | 2020-05-22 | 平安普惠企业管理有限公司 | 联调方法、装置、计算机设备及可读存储介质 |
CN112328486A (zh) * | 2020-11-06 | 2021-02-05 | 深圳壹账通智能科技有限公司 | 接口自动化测试方法、装置、计算机设备及存储介质 |
CN112491649A (zh) * | 2020-11-17 | 2021-03-12 | 中国平安财产保险股份有限公司 | 接口联调测试方法、装置、电子设备及存储介质 |
CN114003432A (zh) * | 2021-09-28 | 2022-02-01 | 济南浪潮数据技术有限公司 | 参数校验方法、装置、计算机设备和存储介质 |
CN114490336A (zh) * | 2021-12-28 | 2022-05-13 | 阿里云计算有限公司 | 一种联调测试方法、接入***、前端及存储介质 |
-
2022
- 2022-06-16 CN CN202210686333.9A patent/CN115086436B/zh active Active
Patent Citations (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN108089985A (zh) * | 2017-12-14 | 2018-05-29 | 中国平安人寿保险股份有限公司 | 接口返回参数的校验方法、装置、设备及可读存储介质 |
CN112650488A (zh) * | 2019-10-12 | 2021-04-13 | 上海际链网络科技有限公司 | 参数校验方法及装置、存储介质、服务终端 |
Also Published As
Publication number | Publication date |
---|---|
CN115086436A (zh) | 2022-09-20 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
CN112448956B (zh) | 一种短信验证码的权限处理方法、装置和计算机设备 | |
CN108933789B (zh) | 一种防止个人信息泄漏的方法及第三方应用服务器 | |
CN112561690B (zh) | ***分期业务接口的测试方法、***、设备及存储介质 | |
CN115086436B (zh) | Api间参数校验方法、装置、计算机设备及存储介质 | |
CN113691618A (zh) | 消息通知方法、装置、消息中心及存储介质 | |
CN108345508B (zh) | 接口调用测试方法和装置 | |
CN110198222A (zh) | 一种配电自动化终端即插即用测试方法及测试主站 | |
CN109214189B (zh) | 识别程序漏洞的方法、装置、存储介质和电子设备 | |
CN114650211B (zh) | 故障修复方法、装置、电子设备和计算机可读存储介质 | |
CN112214475B (zh) | 一种多种数据源配置方法、***、存储介质及终端 | |
CN113868116A (zh) | 测试依赖数据的生成方法、装置、服务器及存储介质 | |
CN107276852B (zh) | 一种数据安全检测方法及终端 | |
CN111324368A (zh) | 一种数据共享方法及服务器 | |
CN113660288B (zh) | 基于区块链***的用户号码绑定方法和绑定*** | |
CN112040430B (zh) | 短信发送方法、装置、服务器及存储介质 | |
CN117331754B (zh) | 异常问题还原方法、***、电子设备和计算机存储介质 | |
CN114417359B (zh) | 一种反弹方式确定方法、装置、设备及存储介质 | |
CN114390457B (zh) | 一种短信验证方法、装置、设备及存储介质 | |
CN110740120B (zh) | 账户信息的处理方法及装置 | |
CN111339120B (zh) | 短信审批编号生成方法、处理方法、电子设备及存储介质 | |
CN116841858A (zh) | 一种服务测试方法及装置 | |
CN116205681A (zh) | 资源兑换方法、装置、计算机设备及计算机可读存储介质 | |
CN115220822A (zh) | 接口挡板的实现方法及装置 | |
CN115511563A (zh) | 业务订单的核验方法、装置、电子设备及存储介质 | |
CN115269429A (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 | ||
GR01 | Patent grant | ||
GR01 | Patent grant |