CN112905455A - 接口信息的校验方法、装置、设备及存储介质 - Google Patents

Abstract

本公开实施例公开了一种接口信息的校验方法、装置、设备及存储介质。包括：获取前端数据请求对应的接口信息；按照设定规则对所述接口信息进行校验；根据校验不通过的接口信息生成上报信息；将所述上报信息发送至设定平台。本公开实施例提供的接口信息的校验方法，按照设定规则对数据请求对应的接口信息进行校验，并将由校验不通过的接口信息生成的上报信息上报至设定平台，以规范接口格式，从而降低前后端在跨项目开发时的成本，提高开发效率。

Description

接口信息的校验方法、装置、设备及存储介质

技术领域

本公开实施例涉及数据接口技术领域，尤其涉及一种接口信息的校验方法、装置、设备及存储介质。

背景技术

目前前后端接口定义混乱没有通用规范，使得前后端在跨项目开发时成本较高，并且在使用通用工具和组件时存在兼容性问题，降低开发效率。目前业界没有技术手段保证接口格式遵守规范，仅靠开发人员自觉遵守，执行效果较差。

发明内容

本公开实施例提供一种接口信息的校验方法、装置、设备及存储介质，可以规范接口格式，从而降低前后端在跨项目开发时的成本，提高开发效率。

第一方面，本公开实施例提供了一种接口信息的校验方法，包括：

获取前端数据请求对应的接口信息；

按照设定规则对所述接口信息进行校验；

根据校验不通过的接口信息生成上报信息；

将所述上报信息发送至设定平台。

第二方面，本公开实施例还提供了一种接口信息的校验装置，包括：

接口信息获取模块，用于获取前端数据请求对应的接口信息；

接口信息校验模块，用于按照设定规则对所述接口信息进行校验；

上报信息生成模块，用于根据校验不通过的接口信息生成上报信息；

上报信息发送模块，用于将所述上报信息发送至设定平台。

第三方面，本公开实施例还提供了一种电子设备，所述电子设备包括：

一个或多个处理装置；

存储装置，用于存储一个或多个程序；

当所述一个或多个程序被所述一个或多个处理装置执行，使得所述一个或多个处理装置实现如本公开实施例所述的接口信息的校验方法。

第四方面，本公开实施例还提供了一种计算机可读介质，其上存储有计算机程序，该程序被处理装置执行时实现如本公开实施例所述的接口信息的校验方法。

本公开实施例公开了一种接口信息的校验方法、装置、设备及存储介质。获取前端数据请求对应的接口信息；按照设定规则对所述接口信息进行校验；根据校验不通过的接口信息生成上报信息；将所述上报信息发送至设定平台。本公开实施例提供的接口信息的校验方法，按照设定规则对数据请求对应的接口信息进行校验，并将由校验不通过的接口信息生成的上报信息上报至设定平台，以规范接口格式，从而降低前后端在跨项目开发时的成本，提高开发效率。

附图说明

图1是本公开实施例中的一种接口信息的校验方法的流程图；

图2是本公开实施例中的一种接口信息的校验装置的结构示意图；

图3是本公开实施例中的一种电子设备的结构示意图。

具体实施方式

下面将参照附图更详细地描述本公开的实施例。虽然附图中显示了本公开的某些实施例，然而应当理解的是，本公开可以通过各种形式来实现，而且不应该被解释为限于这里阐述的实施例，相反提供这些实施例是为了更加透彻和完整地理解本公开。应当理解的是，本公开的附图及实施例仅用于示例性作用，并非用于限制本公开的保护范围。

应当理解，本公开的方法实施方式中记载的各个步骤可以按照不同的顺序执行，和/或并行执行。此外，方法实施方式可以包括附加的步骤和/或省略执行示出的步骤。本公开的范围在此方面不受限制。

本文使用的术语“包括”及其变形是开放性包括，即“包括但不限于”。术语“基于”是“至少部分地基于”。术语“一个实施例”表示“至少一个实施例”；术语“另一实施例”表示“至少一个另外的实施例”；术语“一些实施例”表示“至少一些实施例”。其他术语的相关定义将在下文描述中给出。

需要注意，本公开中提及的“第一”、“第二”等概念仅用于对不同的装置、模块或单元进行区分，并非用于限定这些装置、模块或单元所执行的功能的顺序或者相互依存关系。

需要注意，本公开中提及的“一个”、“多个”的修饰是示意性而非限制性的，本领域技术人员应当理解，除非在上下文另有明确指出，否则应该理解为“一个或多个”。

本公开实施方式中的多个装置之间所交互的消息或者信息的名称仅用于说明性的目的，而并不是用于对这些消息或信息的范围进行限制。

图1为本公开实施例提供的一种接口信息的校验方法的流程图，本实施例可适用于对前后端的接口格式进行检验的情况，该方法可以由接口信息的校验装置来执行，该装置可由硬件和/或软件组成，并一般可集成在具有接口信息的校验功能的设备中，该设备可以是服务器、移动终端或服务器集群等电子设备。如图1所示，该方法具体包括如下步骤：

步骤110，获取前端数据请求对应的接口信息。

其中，前端数据请求可以理解为前端向服务端发起的数据请求。本实施例中，前端数据请求可以通过XHR(XML Http Request)方法或者Fetch方法实现。接口信息可以包括统一资源定位符(Uniform Resource Locator，URL)、请求参数及服务端的返回数据。

本实施例中，由于前端数据请求可以通过XHR方法或者Fetch方法实现，因此，获取前端数据请求对应的接口信息的方式可以是：对前端数据请求函数进行重写；根据重写的前端请求函数提取接口信息。

本实施例中，对前端数据请求函数进行重写之后，还包括如下步骤：将重写的前端数据请求函数封装为软件工具包SDK；将SDK配置与前端项目中。

具体的，对XHR函数或者Fetch函数进行重写，并将重写的函数封装为SDK，将SDK配置于前端项目。当检测到前端发起数据请求时，运行SDK以对数据请求对应的接口信息进行拦截，从而获得前端数据请求对应的URL、请求参数及服务端的返回数据。

步骤120，按照设定规则对接口信息进行校验。

其中，设定规则可以由开发团队设置的。本实施例中，对接口信息进行校验可以理解为对接口信息的书写格式进行校验。

其中，URL的书写格式为仅可以包括小写字母、数字及下划线。请求参数的书写格式为采用小驼峰命名法且仅可以包括大写字母和小写字母，例如：userName。服务端返回的数据的书写格式为：外层数据格式与响应类型对应，时间采用时间戳格式，分页数据采用设定格式。

其中，若响应类型为application或者json，则外层数据格式为：{code:0,msg:“”,data:{}}。分页数据的采样的设定格式可以是：在数据层级下使用数量总量(total)+页数(page)+页码(pageSize)的格式。

具体的，按照设定规则对接口信息进行校验的过程可以是：按照设定规则分别对URL、请求参数及服务端返回的数据的书写格式进行校验。

本实施例中，检验URL是否仅包括小写字母、数字及下划线，若不是，则URL校验不通过。检验请求参数是否采用小驼峰命名法且仅包括大写字母和小写字母，若不是，则请求参数校验不通过。检验服务端返回的数据的格式是否满足外层数据格式与响应类型对应，时间采用时间戳格式，分页数据采用设定格式，若不是，则服务端返回的数据检验不通过。

步骤130，根据校验不通过的接口信息生成上报信息。

其中，上报信息包括项目标识、项目名称及错误类型。其中，错误类型可以包括URL地址命名错误、请求参数命名错误、返回数据格式错误及时间返回值错误等。上报信息还可以包括错误详情。

具体的，根据校验不通过的接口信息生成上报信息的过程可以是：获取校验不通过的接口信息所属的项目标识、项目名称及错误类型；根据校验不通过的接口信息、项目标识、项目名称及错误类型生成上报信息。

本实施例中，上报信息的形式为：项目标识+项目名称+错误类型+错误详情。

步骤140，将上报信息发送至设定平台。

其中，设定平台可以理解为对上报信息进行存储及管理的平台。

可选的，在将上报信息发送至设定平台之后，还包括如下步骤：每隔设定时长获取设定平台中的上报信息；对上报信息进行统计及分析，生成接口报告。

具体的，可以根据上报信息中的错误类型及项目标识进行归类，即将相同项目标识及相同错误类型的上报信息归为一类。

可选的，在生成接口报告之后，还包括如下步骤：将接口报告发送至设定人员，以规范接口信息。

本实施例中，可以根据项目标识将接口报告发送至对应的项目负责人，使得项目负责人在项目开发时对接口格式进行规范。即项目负责人可以监督开发人员在开发项目时按照规定的格式编写接口信息。

本公开实施例的技术方案，获取前端数据请求对应的接口信息；按照设定规则对所述接口信息进行校验；根据校验不通过的接口信息生成上报信息；将所述上报信息发送至设定平台。本公开实施例提供的接口信息的校验方法，按照设定规则对数据请求对应的接口信息进行校验，并将由校验不通过的接口信息生成的上报信息上报至设定平台，以规范接口格式，从而降低前后端在跨项目开发时的成本，提高开发效率。

图2是本公开实施例公开的一种接口信息的校验装置的结构示意图。如图2所示，该装置包括：接口信息获取模块210，接口信息校验模块220，上报信息生成模块230和上报信息发送模块240。

接口信息获取模块210，用于获取前端数据请求对应的接口信息；

接口信息校验模块220，用于按照设定规则对接口信息进行校验；

上报信息生成模块230，用于根据校验不通过的接口信息生成上报信息；

上报信息发送模块240，用于将上报信息发送至设定平台。

可选的，接口信息获取模块210，还用于：

对前端数据请求函数进行重写；

根据重写的前端请求函数提取接口信息；接口信息包括统一资源定位符URL、请求参数及服务端返回的数据。

可选的，还包括：函数封装模块，用于：

将重写的前端数据请求函数封装为软件工具包SDK；

将所述SDK配置与前端项目中；

接口信息获取模块210，还用于：

当检测到前端发起数据请求时，运行所述SDK以拦截接口信息。

可选的，接口信息校验模块220，还用于：

按照设定规则分别对URL、请求参数及服务端返回的数据的书写格式进行校验。

可选的，URL的书写格式为包括小写字母、数字及下划线；请求参数的书写格式为采用小驼峰命名法且包括大写字母和小写字母；服务端返回的数据的书写格式为：外层数据格式与响应类型对应，时间采用时间戳格式，分页数据采用设定格式。

可选的，上报信息生成模块230，还用于：

获取校验不通过的接口信息所属的项目标识、项目名称及错误类型；

根据校验不通过的接口信息、项目标识、项目名称及错误类型生成上报信息。

可选的，还包括：接口报告生成模块，用于：

每隔设定时长获取设定平台中的上报信息；

对上报信息进行统计及分析，生成接口报告。

可选的，还包括：接口报告发送模块，用于：

将接口报告发送至设定人员，以规范接口信息。

上述装置可执行本公开前述所有实施例所提供的方法，具备执行上述方法相应的功能模块和有益效果。未在本实施例中详尽描述的技术细节，可参见本公开前述所有实施例所提供的方法。

下面参考图3，其示出了适于用来实现本公开实施例的电子设备300的结构示意图。本公开实施例中的电子设备可以包括但不限于诸如移动电话、笔记本电脑、数字广播接收器、PDA(个人数字助理)、PAD(平板电脑)、PMP(便携式多媒体播放器)、车载终端(例如车载导航终端)等等的移动终端以及诸如数字TV、台式计算机等等的固定终端，或者各种形式的服务器，如独立服务器或者服务器集群。图3示出的电子设备仅仅是一个示例，不应对本公开实施例的功能和使用范围带来任何限制。

如图3所示，电子设备300可以包括处理装置(例如中央处理器、图形处理器等)301，其可以根据存储在只读存储装置(ROM)302中的程序或者从存储装置305加载到随机访问存储装置(RAM)303中的程序而执行各种适当的动作和处理。在RAM 303中，还存储有电子设备300操作所需的各种程序和数据。处理装置301、ROM 302以及RAM 303通过总线304彼此相连。输入/输出(I/O)接口305也连接至总线304。

通常，以下装置可以连接至I/O接口305：包括例如触摸屏、触摸板、键盘、鼠标、摄像头、麦克风、加速度计、陀螺仪等的输入装置306；包括例如液晶显示器(LCD)、扬声器、振动器等的输出装置307；包括例如磁带、硬盘等的存储装置308；以及通信装置309。通信装置309可以允许电子设备300与其他设备进行无线或有线通信以交换数据。虽然图3示出了具有各种装置的电子设备300，但是应理解的是，并不要求实施或具备所有示出的装置。可以替代地实施或具备更多或更少的装置。

特别地，根据本公开的实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本公开的实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行词语的推荐方法的程序代码。在这样的实施例中，该计算机程序可以通过通信装置309从网络上被下载和安装，或者从存储装置305被安装，或者从ROM 302被安装。在该计算机程序被处理装置301执行时，执行本公开实施例的方法中限定的上述功能。

需要说明的是，本公开上述的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本公开中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本公开中，计算机可读信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读信号介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：电线、光缆、RF(射频)等等，或者上述的任意合适的组合。

在一些实施方式中，客户端、服务器可以利用诸如HTTP(HyperText TransferProtocol，超文本传输协议)之类的任何当前已知或未来研发的网络协议进行通信，并且可以与任意形式或介质的数字数据通信(例如，通信网络)互连。通信网络的示例包括局域网(“LAN”)，广域网(“WAN”)，网际网(例如，互联网)以及端对端网络(例如，ad hoc端对端网络)，以及任何当前已知或未来研发的网络。

上述计算机可读介质可以是上述电子设备中所包含的；也可以是单独存在，而未装配入该电子设备中。

上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被该电子设备执行时，使得该电子设备：获取前端数据请求对应的接口信息；按照设定规则对所述接口信息进行校验；根据校验不通过的接口信息生成上报信息；将所述上报信息发送至设定平台。

可以以一种或多种程序设计语言或其组合来编写用于执行本公开的操作的计算机程序代码，上述程序设计语言包括但不限于面向对象的程序设计语言—诸如Java、Smalltalk、C++，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)—连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。

附图中的流程图和框图，图示了按照本公开各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，该模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本公开实施例中所涉及到的单元可以通过软件的方式实现，也可以通过硬件的方式来实现。其中，单元的名称在某种情况下并不构成对该单元本身的限定。

本文中以上描述的功能可以至少部分地由一个或多个硬件逻辑部件来执行。例如，非限制性地，可以使用的示范类型的硬件逻辑部件包括：现场可编程门阵列(FPGA)、专用集成电路(ASIC)、专用标准产品(ASSP)、片上系统(SOC)、复杂可编程逻辑设备(CPLD)等等。

在本公开的上下文中，机器可读介质可以是有形的介质，其可以包含或存储以供指令执行系统、装置或设备使用或与指令执行系统、装置或设备结合地使用的程序。机器可读介质可以是机器可读信号介质或机器可读储存介质。机器可读介质可以包括但不限于电子的、磁性的、光学的、电磁的、红外的、或半导体系统、装置或设备，或者上述内容的任何合适组合。机器可读存储介质的更具体示例会包括基于一个或多个线的电气连接、便携式计算机盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦除可编程只读存储器(EPROM或快闪存储器)、光纤、便捷式紧凑盘只读存储器(CD-ROM)、光学储存设备、磁储存设备、或上述内容的任何合适组合。

根据本公开实施例的一个或多个实施例，本公开实施例公开了一种接口信息的校验方法，包括：

获取前端数据请求对应的接口信息；

按照设定规则对所述接口信息进行校验；

根据校验不通过的接口信息生成上报信息；

将所述上报信息发送至设定平台。

进一步地，获取前端数据请求对应的接口信息，包括：

对前端数据请求函数进行重写；

根据重写的前端请求函数提取接口信息；所述接口信息包括统一资源定位符URL、请求参数及服务端返回的数据。

进一步地，对前端数据请求函数进行重写之后，还包括：

将重写的前端数据请求函数封装为软件工具包SDK；

将所述SDK配置与前端项目中；

相应的，根据重写的前端请求函数提取接口信息，包括：

当检测到前端发起数据请求时，运行所述SDK以拦截接口信息。

进一步地，按照设定规则对所述接口信息进行校验，包括：

按照设定规则分别对所述URL、请求参数及服务端返回的数据的书写格式进行校验。

进一步地，所述URL的书写格式为包括小写字母、数字及下划线；所述请求参数的书写格式为采用小驼峰命名法且包括大写字母和小写字母；服务端返回的数据的书写格式为：外层数据格式与响应类型对应，时间采用时间戳格式，分页数据采用设定格式。

进一步地，根据校验不通过的接口信息生成上报信息，包括：

获取校验不通过的接口信息所属的项目标识、项目名称及错误类型；

根据所述校验不通过的接口信息、所述项目标识、所述项目名称及所述错误类型生成上报信息。

进一步地，在将所述上报信息发送至设定平台之后，还包括：

每隔设定时长获取所述设定平台中的上报信息；

对所述上报信息进行统计及分析，生成接口报告。

进一步地，在生成接口报告之后，还包括：

将所述接口报告发送至设定人员，以规范所述接口信息。

注意，上述仅为本公开的较佳实施例及所运用技术原理。本领域技术人员会理解，本公开不限于这里所述的特定实施例，对本领域技术人员来说能够进行各种明显的变化、重新调整和替代而不会脱离本公开的保护范围。因此，虽然通过以上实施例对本公开进行了较为详细的说明，但是本公开不仅仅限于以上实施例，在不脱离本公开构思的情况下，还可以包括更多其他等效实施例，而本公开的范围由所附的权利要求范围决定。

Claims (11)

1.一种接口信息的校验方法，其特征在于，包括：

获取前端数据请求对应的接口信息；

按照设定规则对所述接口信息进行校验；

根据校验不通过的接口信息生成上报信息；

将所述上报信息发送至设定平台。

2.根据权利要求1所述的方法，其特征在于，获取前端数据请求对应的接口信息，包括：

对前端数据请求函数进行重写；

根据重写的前端请求函数提取接口信息；所述接口信息包括统一资源定位符URL、请求参数及服务端返回的数据。

3.根据权利要求2所述的方法，其特征在于，对前端数据请求函数进行重写之后，还包括：

将重写的前端数据请求函数封装为软件工具包SDK；

将所述SDK配置与前端项目中；

相应的，根据重写的前端请求函数提取接口信息，包括：

当检测到前端发起数据请求时，运行所述SDK以拦截接口信息。

4.根据权利要求2所述的方法，其特征在于，按照设定规则对所述接口信息进行校验，包括：

按照设定规则分别对所述URL、请求参数及服务端返回的数据的书写格式进行校验。

5.根据权利要求4所述的方法，其特征在于，所述URL的书写格式为包括小写字母、数字及下划线；所述请求参数的书写格式为采用小驼峰命名法且包括大写字母和小写字母；服务端返回的数据的书写格式为：外层数据格式与响应类型对应，时间采用时间戳格式，分页数据采用设定格式。

6.根据权利要求1所述的方法，其特征在于，根据校验不通过的接口信息生成上报信息，包括：

获取校验不通过的接口信息所属的项目标识、项目名称及错误类型；

根据所述校验不通过的接口信息、所述项目标识、所述项目名称及所述错误类型生成上报信息。

7.根据权利要求1所述的方法，其特征在于，在将所述上报信息发送至设定平台之后，还包括：

每隔设定时长获取所述设定平台中的上报信息；

对所述上报信息进行统计及分析，生成接口报告。

8.根据权利要求7所述的方法，其特征在于，在生成接口报告之后，还包括：

将所述接口报告发送至设定人员，以规范所述接口信息。

9.一种接口信息的校验装置，其特征在于，包括：

接口信息获取模块，用于获取前端数据请求对应的接口信息；

接口信息校验模块，用于按照设定规则对所述接口信息进行校验；

上报信息生成模块，用于根据校验不通过的接口信息生成上报信息；

上报信息发送模块，用于将所述上报信息发送至设定平台。

10.一种电子设备，其特征在于，所述电子设备包括：

一个或多个处理装置；

存储装置，用于存储一个或多个程序；

当所述一个或多个程序被所述一个或多个处理装置执行，使得所述一个或多个处理装置实现如权利要求1-8中任一所述的接口信息的校验方法。

11.一种计算机可读介质，其上存储有计算机程序，其特征在于，该程序被处理装置执行时实现如权利要求1-8中任一所述的接口信息的校验方法。

Images