一种接口入参校验方法、装置、电子设备与存储介质与流程

1.本技术涉及数据处理的技术领域，具体而言，涉及一种接口入参校验方法、装置、电子设备与存储介质。


背景技术：

2.现有技术中，前端与后端进行接口联调时，前端在请求获取后端数据。当响应数据失败时，前端并不清楚错误原因，需要频繁从后端调用更新后的接口文档查看后端相关的入参信息要求，以及多次与后端人员针对接口文档进行沟通确认问题所在。


技术实现要素：

3.本技术的目的在于提供一种接口入参校验方法、装置、电子设备与存储介质，其能够在前后端接口联调、前端请求获取数据时自动检验前端发送的入参信息。当入参信息错误时，会自动生成错误信息提示，便于前端人员进行入参信息的调整。
4.本技术的实施例是这样实现的：
5.本技术实施例第一方面提供了一种接口入参校验方法，该方法应用于前端，包括：当接收到参数校验功能的开启指令时，获取接口文档标识；根据接口文档标识，获取接口文档标识对应的接口文档；基于接口文档生成校验规则；根据校验规则，判断接口文档标识对应的入参信息是否通过校验。
6.于一实施例中，若接收到入参信息，但未接收到参数校验功能的开启指令，直接发送入参信息至后端以获取响应数据。
7.于一实施例中，基于接口文档生成校验规则，包括：基于接口文档生成对应的json文件；基于json文件，生成入参信息对应的校验规则。
8.于一实施例中，获取接口文档标识对应的接口文档，包括：将接口文档标识发送到后端，以从后端获取接口文档标识对应的接口文档。
9.于一实施例中，在根据校验规则，判断接口文档标识对应的入参信息是否通过校验之后，包括：若入参信息未通过校验，生成校验未通过的相关提示信息。
10.于一实施例中，在根据校验规则，判断接口文档标识对应的入参信息是否通过校验之后，还包括：发送入参信息至后端，若入参信息通过校验，获取入参信息对应的响应数据。
11.于一实施例中，入参信息包括接口入参名称与接口参数类型。
12.本技术实施例第二方面提供了一种接口入参校验装置，该装置应用于前端，包括：第一获取模块，用于当接收到参数校验功能的开启指令时，获取接口文档标识；第二获取模块，用于根据接口文档标识，获取接口文档标识对应的接口文档；生成模块，用于基于接口文档生成校验规则；判断模块，用于根据校验规则，判断接口文档标识对应的入参信息是否通过校验。
13.本技术实施例第三方面提供了一种电子设备，电子设备包括：处理器和用于存储
处理器可执行指令的存储器；其中，处理器被配置用以执行本技术实施例第一方面及其任一实施例的接口入参校验方法。
14.本技术实施例第四方面提供了一种计算机可读存储介质，存储介质存储有计算机程序。计算机程序可由处理器执行，以完成本技术实施例第一方面及其任一实施例的接口入参校验方法。
15.本技术与现有技术相比的有益效果是：
16.本技术能够解决前后端接口联调以使前端请求获取后端数据时，因前端输入的接口入参信息错误造成获取数据失败，前端却无法确认错误原因的问题。本技术通过拉取后端提供的接口文档并依此生成校验规则，对前端输入的接口入参信息进行校验，并生成相关的提示信息，便于前端后续针对错误原因进行修改。本技术节省了开发人员的开发时间与沟通成本，提高了开发人员的开发效率。
附图说明
17.为了更清楚地说明本技术实施例的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，应当理解，以下附图仅示出了本技术的某些实施例，因此不应被看作是对范围的限定，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他相关的附图。
18.图1为本技术一实施例提供的接口入参校验方法的应用场景示意图；
19.图2为本技术一实施例提供的电子设备的结构示意图；
20.图3为本技术一实施例提供的接口入参校验方法的流程示意图；
21.图4为本技术一实施例提供的接口入参校验方法的流程示意图；
22.图5为本技术一实施例提供的接口入参校验装置的结构示意图。
23.附图标记：1-电子设备；100-客户端；10-存储器；11-总线；12-处理器；200-网络；300-服务端；600-接口入参校验装置；610-第一获取模块；620-第二获取模块；630-生成模块；640-判断模块。
具体实施方式
24.下面将结合本技术实施例中的附图，对本技术实施例中的技术方案进行描述。
25.相似的标号和字母在下面的附图中表示类似项，因此，一旦某一项在一个附图中被定义，则在随后的附图中不需要对其进行进一步定义和解释。同时，在本技术的描述中，术语“第一”、“第二”等仅用于区分描述，而不能理解为指示或暗示相对重要性。
26.下面将结合附图对本技术的技术方案进行清楚、完整地描述。
27.请参见图1，图1为本技术一实施例提供的接口入参校验方法的应用场景示意图。如图1所示，该应用场景包括客户端100和服务端300，客户端100与服务端300之间通过网络200连接。客户端100和服务端300可以是个人电脑、平板电脑、智能手机等。服务端300也可以是服务器或服务器集群。客户端100可以执行本技术实施例提供的接口入参校验方法并从服务端300获取数据，为表述方便，本技术实施例以前端作为客户端100并作为执行主体，以后端作为服务端300展开描述。
28.前端与后端进行接口联调时常遇到接口参数问题，前端向后端请求获取响应数据
失败时却不知道原因。本技术实施例在前端发送请求时，拉取后端接口文档生成相关校验规则，对请求中包括的入参信息进行校验，在前端发送的入参信息错误时，可以反馈校验不通过相关提示信息，便于前端开发人员在终端根据提示信息进行调整，节省了反复与后端确认问题归属与问题原因的时间，提高了开发效率。
29.请参见图2，图2为本技术一实施例提供的电子设备1的结构示意图，该电子设备1可以作为上述服务端300或客户端100。如图2所示，电子设备1包括至少一个处理器12和存储器10，图2中以一个处理器12为例。处理器12和存储器10通过总线11连接，存储器10存储有可被至少一个处理器12执行的指令，指令被至少一处理器12执行，以使至少一个处理器12执行如下述实施例中的接口入参校验方法。
30.在本技术实施例中，可以在前端设有中间件，执行如下述实施例中的接口入参校验方法，也可以由其他处理器12执行。
31.请参见图3，图3为本技术一实施例提供的接口入参校验方法的流程示意图。接口入参校验方法应用于前端，如图3所示，该方法包括：
32.s410:当接收到参数校验功能的开启指令时，获取接口文档标识。
33.于本技术实施例中，参数校验功能是指在前端发送请求获取数据的相关信息时进行的校验过程。前端需要在接口对接以请求获取需求数据时，基于后端提供的接口文档发送相关入参信息，接口文档标识是指在前端开发人员开启参数校验功能时，开发人员输入的后端对应存储的接口文档标识。
34.在该步骤中，前端开发人员可以在接入本技术实施例提供的接口入参校验方法相关应用时，配置是否开启接口参数校验的能力。当前端开发人员选择配置该能力，前端可以接收到参数校验功能的开启指令，并在开发人员需要接口联调获取数据时，接收开发人员输入的需要检验的接口参数对应的接口文档标识。
35.s420:根据接口文档标识，获取接口文档标识对应的接口文档。
36.在该步骤中，前端根据接口文档标识，从后端获取对应的接口文档。
37.于本技术实施例中，接口文档标识不会随后端更新接口文档中接口的相关参数信息而改变，因此可以做到后续步骤中前端获取接口文档以生成校验规则时，根据接口文档标识准确拉取后端更新后的最新版接口文档。
38.s430:基于接口文档生成校验规则。
39.在该步骤中，前端基于拉取后端更新后的最新版接口文档，生成对应的校验规则。这样在前端发送获取数据请求相关信息且后端更新了接口参数后，前端校验后得到的提示信息是准确、且对应最新接口文档的。
40.s440:根据校验规则，判断接口文档标识对应的入参信息是否通过校验。
41.在该步骤中，前端从后端请求获取数据并已经开启校验时，需要基于入参调用的接口，向后端发送对应的接口文档标识以及对应接口的相关入参信息，本技术实施例可以在前端发送请求相关信息的同时进行校验。因此无论校验通过与否都不影响后端向前端响应相关信息。
42.请参见图4，图4为本技术一实施例提供的接口入参校验方法的流程示意图。如图4所示，接口入参校验方法包括：
43.s510:接收参数校验功能的开启指令。
44.参数校验是指在前端发送请求获取数据的相关信息时进行的校验。在该步骤中，前端开发人员可以在接入本技术实施例提供的接口入参校验方法相关应用时，配置是否开启接口参数校验的功能。当前端开发人员选择配置该功能，即向前端发送开启参数校验的功能，前端就可以接收到参数校验功能的开启指令，并执行步骤s530至s560；当前端开发人员选择不配置该功能，则前端未接收到参数校验功能的开启指令，或接收到参数校验功能的不开启指令，即执行步骤s520。
45.s520:若接收到入参信息，但未接收到参数校验功能的开启指令，直接发送入参信息至后端以获取响应数据。
46.入参信息包括接口入参名称与接口参数类型。在该步骤中，前端可选择不开启参数校验功能的配置，前端依旧正常向后端发送请求获取数据且不受影响，但前端未接收到开发人员输入的开启指令时，不会执行下述接口入参校验方法，当前端向后端请求获取数据失败时无法生成相关提示信息，前端开发人员无法基于相关提示信息对请求入参的接口参数信息直接进行调整，需要消耗大量时间与后端开发人员进行沟通，并频繁调取后端的接口文档进行查阅，来定位问题归属与错误原因，这样消耗大量的人力物力，且降低了开发效率。
47.s530:当接收到参数校验功能的开启指令时，获取接口文档标识。
48.前端可以接收到开启指令，并在开发人员需要接口联调获取数据时，接收开发人员输入的需要检验的接口参数对应的接口文档标识。该步骤与上述步骤s410相似，具体细节请参考步骤s410。
49.s540:根据接口文档标识，获取接口文档标识对应的接口文档。
50.在该步骤中，前端人员将接口文档标识发送到后端，以从后端获取接口文档标识对应的接口文档，该步骤与上述步骤s420相似，具体细节请参考步骤s420。
51.s550:基于接口文档生成校验规则。
52.在该步骤中，前端基于拉取后端更新后的最新的接口文档，生成对应的校验规则。在前端发送获取数据请求入参信息时，基于后端更新接口参数后的接口文档，生成的入参信息对应的校验规则也是最新的。由此前端请求获取数据后得到的提示信息，是准确对应后端提供的最新接口文档相关参数要求的。这样只需要保证后端接口文档正确，前端就可以对应调整入参信息。
53.该步骤包括以下子步骤：
54.s551:基于接口文档生成对应的json文件。
55.json(javascr ipt object notati on,js对象简谱)是一种轻量级的数据交换格式。它基于ecmascr ipt(欧洲计算机协会制定的规范)的一个子集，采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得json成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。
56.在该步骤中，前端基于后端编写好的接口文档，同时根据已有接口生成一对一的接口json文件，同时接口文档变化以后，可以同步并生成最新的json文件。
57.s552:基于json文件，生成入参信息对应的校验规则。
58.在该步骤中，前端根据已生成的json文件，生成接口文档对应的每个接口的参数规则的描述文件，再根据描述文件动态生成接口校验规则，即为前端发送的入参信息对应
的校验规则。这样前端可以在入参信息不满足规则的场景下给出对应提示，便于前端开发人员针对接口参数变化与接口参数缺失的问题得到准确的解决方案，或获取有效的参数问题改进提示。
59.s560:根据校验规则，判断接口文档标识对应的入参信息是否通过校验。
60.在该步骤中，前端基于接口文档，判断对应发送的入参信息是否通过校验后，并不会影响前端向后端请求获取数据。在该步骤之后，若入参信息通过校验，执行下述步骤s570；若未通过校验，执行下述步骤s580。
61.s570:若入参信息通过校验，则获取入参信息对应的响应数据。
62.前端发送入参信息，以从后端获取对应的响应数据，并且前端会对发送的入参信息进行校验。入参信息通过校验时，前端可以获取对应的响应数据。若前端请求响应数据且入参信息通过校验，却未获取到对应的响应数据或获取响应数据失败，则可以依据接口文档与后端的开发人员联系，确认问题归属是否为后端配置错误。
63.s580:若入参信息未通过校验，生成校验未通过的相关提示信息。
64.前端发送入参信息，以从后端获取对应的响应数据，并且前端会对发送的入参信息进行校验。入参信息未通过校验时，前端生成校验未通过的相关提示信息，提示由于接口参数变化或接口参数缺失等错误原因，造成的获取数据失败。前端开发人员针对相关提示信息修改入参信息，例如接口入参名称与接口参数类型，这样避免了前端开发人员频繁查阅接口文档或与后端开发人员频繁沟通而造成项目进度缓慢，节省了大量人力物力。
65.于本技术另一实施例中，前端也可以在判断入参信息未通过校验后对发送的请求进行拦截。待前端开发人员修改后的入参信息，通过基于最新接口文档生成的校验规则后，才不再对请求信息进行拦截，进而后端可以接收到前端发送的获取数据的请求并响应相关数据。
66.本技术能够解决前后端接口联调以使前端请求获取后端数据时，因前端输入的接口入参信息错误造成获取数据失败，前端却无法确认错误原因与问题归属的问题。本技术通过拉取后端提供的接口文档并依此生成校验规则，对前端输入的接口入参信息进行校验，并生成相关的提示信息，便于前端后续针对错误原因进行修改。本技术节省了开发人员的开发沟通时间与开发沟通成本，提高了开发人员的开发效率。
67.请参见图5，图5为本技术一实施例提供的接口入参校验装置600的结构示意图。该装置应用于前端，如图5所示，接口入参校验装置600包括：第一获取模块610，用于当接收到参数校验功能的开启指令时，获取接口文档标识；第二获取模块620，用于根据接口文档标识，获取接口文档标识对应的接口文档；生成模块630，用于基于接口文档生成校验规则；判断模块640，用于根据校验规则，判断接口文档标识对应的入参信息是否通过校验。
68.上述装置中各个模块的功能和作用的实现过程，具体详见上述接口入参校验方法中对应步骤的实现过程，在此不再赘述。
69.在本技术所提供的几个实施例中，所揭露的装置和方法，也可以通过其它的方式实现。以上所描述的装置实施例仅仅是示意性的，例如，附图中的流程图和框图显示了根据本技术的多个实施例的装置、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段或代码的一部分，模块、程序段或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。在有些作
为替换的实现方式中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个连续的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依据所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或动作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。
70.另外，在本技术各个实施例中的各功能模块可以集成在一起形成一个独立的部分，也可以是各个模块单独存在，也可以两个或两个以上模块集成形成一个独立的部分。
71.本技术实施例提供了一种计算机可读存储介质，存储介质存储有计算机程序。计算机程序可由处理器12执行，以完成本技术任一实施例接口入参校验方法。
72.功能如果以软件功能模块的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本技术的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络200设备等)执行本技术各个实施例方法的全部或部分步骤。而前述的存储介质包括：u盘、移动硬盘、只读存储器(rom，read-on ly memory)、随机存取存储器(ram，random access memory)、磁碟或者光盘等各种可以存储程序代码的介质。
73.以上所述仅为本技术的优选实施例而已，并不用于限制本技术，对于本领域的技术人员来说，本技术可以有各种更改和变化。凡在本技术的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本技术的保护范围之内。