CN115269066B - 接口调用方法、设备及存储介质 - Google Patents

Abstract

本申请公开了一种接口调用方法、设备及存储介质，接口调用方法包括：获取网页框架的第一配置文件中的配置对象，并获取该配置对象的目标字段，接着，利用目标接口获取与目标字段对应的第二配置文件，之后，基于第二配置文件，获取与目标接口对应的接口链接文件，以及基于接口调用规则，生成与接口链接文件对应的接口调用文件。通过上述方法，本申请提供的接口调用方法可以通过生成接口调用文件，以实现接口调用。

Description

接口调用方法、设备及存储介质

技术领域

本申请涉及前端技术领域，特别是一种接口调用方法、设备及存储介质。

背景技术

目前，前端开发使用市场上使用成熟的框架进行网页开发管理，但是目前所使用的网页开发方法中每次想要使用接口时需要在项目中增加编写引用的接口链接、编写接口基础调用等工作，重复的编写工作加重了工作负担，且效率较低。

发明内容

本申请提供了一种接口调用方法、设备及存储介质，通过获取网页框架上特定配置对象的目标字段来获取对应的接口调用文件，从而实现接口调用，且可以通过显示页面直接调用该接口调用文件，使得接口调用过程较为便捷。

为了解决上述技术问题，本申请采用的一个技术方案是：获取网页框架的第一配置文件中的配置对象，并获取该配置对象的目标字段；接着，利用目标接口获取与目标字段对应的第二配置文件，以及基于该第二配置文件，获取与目标接口对应的接口链接文件；最后，基于接口调用规则，生成与接口链接文件对应的接口调用文件。

其中，网页框架为VueJS框架。

其中，获取配置对象的目标字段，包括：响应于调用配置对象的功能的调用指令，调用配置对象，以得到该配置对象中的目标字段。

其中，利用目标接口获取与目标字段对应的第二配置文件，包括：基于目标字段，调用目标接口遍历文件库，以得到文件库中与目标字段对应的第二配置文件，其中第二配置文件为数据交换文件。

其中，基于第二配置文件，获取与目标接口对应的接口链接文件，包括：获取第二配置文件中与目标接口对应的接口链接信息；基于目标容器，生成与接口链接信息对应的接口链接文件。

其中，生成与目标接口对应的接口调用文件，包括：基于目标容器，生成与目标接口对应的接口调用文件。

其中，目标容器为沙箱。

其中，所述方法还包括：对接口调用文件进行校验。

其中，生成与接口链接文件对应的接口调用文件之后，所述方法还包括：将接口调用文件显示在显示页面上。

其中，目标接口为API接口。

其中，接口调用规则为API接口对应的结构调用规则。

为了解决上述技术问题，本申请采用的另一技术方案是：提供一种接口调用设备，该接口调用设备包括存储器和处理器，其中，存储器用于存储程序数据，处理器用于执行程序数据以实现上述接口调用方法。

为了解决上述技术问题，本申请采用的另一技术方案是：提供一种计算机可读存储介质，该计算机可读存储介质中存储有程序数据，程序数据在被处理器执行时，用于执行上述接口调用方法。

本申请的有益效果是：区别于现有技术，本申请提供的一种接口调用方法，通过获取网页框架的第一配置文件中的配置对象，以及获取配置对象的目标字段，接着，利用目标接口获取与目标字段对应的第二配置文件，以及基于第二配置文件，获取与目标接口对应的接口链接文件，最后，基于接口调用规则，生成与接口链接文件对应的接口调用文件。通过上述方式，通过特定配置文件中的配置对象的目标字段，进而获取接口链接文件、接口调用文件，可以实现接口调用，进而将接口调用文件显示在显示页面上，可以直接通过可视化页面直接调用对应的接口，使得接口调用较为便捷。

附图说明

为了更清楚地说明本申请实施例中的技术方案，下面将对实施例描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。其中：

图1是本申请提供的接口调用方法第一实施例的流程示意图；

图2是本申请提供的接口调用方法第二实施例的流程示意图；

图3是本申请提供的接口调用方法第三实施例的流程示意图；

图4是本申请提供的接口调用方法第四实施例的流程示意图；

图5是本申请提供的接口调用设备一实施例的结构示意图；

图6是本申请提供的计算机可读存储介质一实施例的结构示意图。

具体实施方式

下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅是本申请的一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。

参阅图1，图1是本申请提供的接口调用方法第一实施例的流程示意图，该方法包括：

步骤11：获取网页框架的第一配置文件中的配置对象。

可选地，网页框架可以是VueJS框架、Bootstrap框架、Layui框架、Element-UI框架、Mint UI框架、Angular框架或React框架等。

在一实施例中，网页框架是VueJS框架，Vue是一个js库，Vue又称渐进式框架，由底层上传逐层应用，用于将页面代码进行组件化和规范化、单页面开发、提供浏览器加载速度、加上代码写作等，其采用MVVM模式，可以实现动态加载标签、动画效果、表单验证、链接后台等功能。

在一些实施例中，搭建Vue环境的时候会产生很多文件，包括build文件、config文件、App.vue文件、.vue文件、main.js文件、.babelrc文件等。

其中，build文件是打包所需的配置文件夹；config 是项目的配置文件夹；src 是项目开发存放源代码的地方；App.vue是入口组件；.vue 的格式文件是组件文件；main.js项目入口的文件；.babelrc 文件是es6的配置文件；editorconfig sublime编辑器的配置；.postcssrc.js 是html添加前缀的配置文件；index.html 单页面的入口；package.json 依赖包的配置文件。

在一些实施例中，第一配置文件是名为.owlrc.config.js的文件，该文件是项目配置文件，可用于传递虚拟接口到环境中、传递配置对象到环境中等。

在一些实施例中，配置对象是COM，在COM规范中，并没有对COM对象进行严格定义，但COM 提供的是面向对象的组件模型，而COM 组件提供给客户的是以对象形式封装起来的实体。也就是说，用户程序与 COM 程序进行交互的实体是 COM 对象，而用户程序通过COM接口获取COM组件对象的服务。

另外，COM接口是包含了一组函数的数据结构，通过这组数据结构，用户可以调用组件对象的功能。

具体地，在一实施例中配置对象是comapi，即使用COM提供的API接口创建COM对象。

在一些实施例中，通过VueJS框架的API接口获取.owlrc.config.js配置文件中的comapi配置对象。

步骤12：获取配置对象的目标字段。

具体地，目标字段是pkgname字段，且是comapi的pkgname字段。

在一些实施例中，pkgname字段指包名称，且是项目名称。

步骤13：利用目标接口获取与目标字段对应的第二配置文件。

在一些实施例中，目标接口是API接口。

在一些实施例中，第二配置文件是Gitlab中的项目配置文件，也就是JSON文件。

在一些实施例中，通过get方法调用Gitlab的API接口，并通过该API接口获取Gitlab仓库中的JSON文件。

其中，get方法指从指定资源中请求数据。在其他实施例中，请求方法还包括post方法、put方法、head方法等。

其中，Gitlab是一个用于仓库管理系统的开源项目，使用Git（是一个开源的分布式版本控制系统，可以有效、高速地处理从很小到非常大的项目版本管理）作为代码管理工具，并在此基础上搭建起来的Web服务。

其中，JSON（JavaScript Object Notation）文件是用来存储简单的数据结构和对象的文件，可以在web应用程序中进行数据交换。

步骤14：基于第二配置文件，获取与目标接口对应的接口链接文件。

具体地，接口链接文件是接口链接按照项目接口的使用规范生成的文件。

在一些实施例中，接口链接文件是按照API接口使用规范生成的文件。

步骤15：基于接口调用规则，生成与接口链接文件对应的接口调用文件。

具体地，接口调用规则为与接口对应的接口调用规则。

具体地，接口调用文件包括API接口调用文件和Urls文件，用于调用API接口和生成页面（或网页）。

其中，Urls文件是URL（Uniform Resource Locator，统一资源定位符）格式的文件，而URL格式的文件是一种网页文件，指向本机当前建立服务器的一个连接，如果可以正常打开说明服务器已经搭建成功。Internet上的每一个网页都具有一个唯一的名称标识，通常称之为URL地址，这种地址可以是本地磁盘，也可以是局域网上的某一台计算机，还可以是网页程序或者应用软件内部地址的指向标识。但更多的是指Internet上的站点。简单地说，URL就是Web地址，俗称“网址”。

在一些实施例中，可以通过Urls文件直接生成网页/页面，可以是通过点击URL（地址）直接进入网页/页面，或者是将下载该Urls文件使用第三方平台（如手机或电脑上的搜索软件）实现。

区别于现有技术，本申请提供的接口调用方法通过获取网页框架的配置文件中的配置对象的目标字段，进而利用目标接口获取与目标字段对应的配置文件，以及基于与目标字段对应的配置文件获取与目标接口对应的接口链接文件和接口调用文件。通过上述方式，可以实现接口调用，且接口链接文件和接口调用文件可以重复调用，而不需要进行重复编写，接口调用方式较为便捷，对用户来说可以减少因接口重复调用而花费的时间。

参阅图2，图2是本申请提供的接口调用方法第二实施例的流程示意图，该方法包括：

步骤21：获取网页框架的第一配置文件中的配置对象。

步骤22：响应于调用配置对象的功能的调用指令，调用配置对象，以得到配置对象中的目标字段。

在一些实施例中，获取网页框架中的目标配置对象，是为了获取该目标配置对象中的目标字段，而使用该目标字段作为相应的项目文件的项目名，根据该项目名可以分辨不同的业务类型。

在一些实施例中，目标字段是pkgname字段，且是comapi的pkgname字段。

步骤23：基于目标字段，调用目标接口遍历文件库，以得到文件库中与目标字段对应的第二配置文件，其中第二配置文件为数据交换文件。

在一些实施例中，文件库是Gitlab仓库，Gitlab仓库包括远程仓库和本地仓库，且Gitlab仓库包含多个项目文件，每一个项目在被创建时需要设置相应的项目名称、项目描述、项目可见级别，其中项目可见级别包括私有项目、内部项目、公开项目。

在一些实施例中，第二配置文件是Gitlab中的项目配置文件，也就是JSON文件，JSON文件可以在web应用程序中进行数据交换。

在一些实施例中，通过遍历Gitlab仓库，获取与pkgname字段（项目名）对应的JSON文件（数据交换文件）。

步骤24：获取第二配置文件中与目标接口对应的接口链接信息。

具体地，接口链接信息包括接口连接端口、接口连接状况等，在调用接口时需要验证该接口是否处于运行状态、空闲状态、接口类型等，以得到目标接口。

在一些实施例中，用户可以通过接口列表调用对应的目标接口，也可以对接口列表中每一接口进行验证，验证接口是否处于空闲状态以及验证与目标接口是否是同一类型的接口。

在一些实施例中，目标接口是API接口，接口链接信息是API接口链接信息。

在一些实施例中，通过循环验证API接口列表中的所有API接口，可以得到目标API接口。

步骤25：基于目标容器，生成与接口链接信息对应的接口链接文件。

具体地，目标容器是沙箱（Sandbox），沙箱是一个虚拟系统程序，用户可以在沙盘环境中运行浏览器或其他程序，它创造了一个类似箱子的独立作业环境。沙箱是指在隔离环境中，用于测试不受信任的文件、应用程序等行为的工具。

步骤26：基于目标容器，利用接口调用规则生成与目标接口对应的接口调用文件。

在一些实施例中，在沙箱中生成接口链接文件和接口调用文件，以实现接口调用，对于接口调用方式来说，可以避免危害生成这些文件的客户端（如智能手机、笔记本电脑、台式电脑等）的安全，换句话说，到一定程度上可以避免进行接口调用时生成的接口调用文件是植入病毒等文件。在沙箱中生成接口链接文件和接口调用文件可以避免一定程度的设备安全使用的威胁，特别是对金融行业（如银行系统）来说，生成安全的接口调用文件是必要的。

区别于现有技术，本申请提供的接口调用方法可以在沙箱中生成安全的接口调用文件，不仅可以实现接口调用，还保障了接口调用过程的安全性。

参阅图3，图3是本申请提供的接口调用方法第三实施例的流程示意图，该方法包括：

步骤31：获取网页框架的第一配置文件中的配置对象。

在一些实施例中，配置对象是comapi配置对象。

步骤32：获取配置对象的目标字段。

在一些实施例中，获取配置对象的目标字段之前需要判断是否需要启动插件服务，其中使用的插件服务是Enable Copy，当判断显示需要启动插件服务是可以启用comapi组件功能，否则出现错误提示“不启用comapi组件功能”。

在一些实施例中，目标字段是pkgname字段。

在一些实施例中，获取comapi配置对象中的pkgname字段作为项目文件名称，以方便后续按照该项目文件名称实现接口调用。

在一些实施例中，需要对获取的目标字段进行验证，验证获取的目标字段是否有值（或是否有内容），若验证显示目标字段有值，则对目标字段进行高亮提示“项目名称”，否则获取package.json配置文件中的name字段作为目标最终的目标字段，也就是说，当目标字段是.owlrc.config.js 配置文件的comapi配置对象的pkgname字段时，该pkgname字段没有值，则获取package.json配置文件中的name字段作为最终的目标字段。

其中，package.json 指依赖包（插件正常运行时需要的一个程序包）的配置文件。

步骤33：利用目标接口获取与目标字段对应的第二配置文件。

在一些实施例中，第二配置文件是JSON文件，通过get方法调用Gitlab仓库的repository/files接口获取Gitlab仓库中项目的配置JSON文件。

步骤34：基于第二配置文件，获取与目标接口对应的接口链接文件。

在一些实施例中，获取第二配置文件之后，还需要进行以下流程（图未示）：

S1：获取配置对象的第一引入配置数组和第二引入配置数组。

具体地，第一引入配置数组是commonImport（公共引入配置数组），第二引入配置数组pluginsImport（插件引入配置数组）。

S2：获取第二配置文件的配置对象，为第二配置对象。

具体地，第二配置对象是json配置对象。

S3：获取第二配置对象的引入配置数组，为第三引入配置数组。

S4：将第一引入配置数组、第二引入配置数组和第三引入配置数组进行合并，得到合并引入配置数组。

S5：循环合并引入配置数组，以验证合并引入配置数组是否包含标引信息，其中标引信息包括第一标引信息和第二标引信息。

具体地，第一标引信息是“project”，第二标引信息是“.json”，且第一标引信息在第二配置对象前面，第二标引信息在第二配置对象后面。

若合并引入配置数组包含标引信息，则执行步骤S6。

S6：获取目标接口的配置文件。

在一些实施例中，通过get方法调用Gitlab仓库的repository/files接口获取Gitlab仓库中API接口的配置文件。

在一些实施例中，获取目标接口的配置文件之后，需要获取由目标接口组成的接口列表，通过对接口列表进行验证，可以获取接口类型符合且接口处于空闲状态的目标接口，并生成对应的接口链接文件。

步骤35：基于接口调用规则，生成与接口链接文件对应的接口调用文件。

在一些实施例中，检测到目标接口的配置文件中同时包含getWindowData（获取窗口数据）字段、cache（缓冲）字段时，可以使用缓存的方式生成接口调用文件。

在一些实施例中，需要步骤31至步骤35可以与上述实施例具有相同或相似的技术方案，这里不做赘述。

步骤36：对接口调用文件进行校验。

在一些实施例中，基于接口调用文件可以生成与该接口调用文件对应的逻辑字符串，且对目标接口调用前和后都可以生成对应的逻辑字符串。

在一些实施例中，可以通过验证目标接口调用前、后的逻辑字符串，以对接口调用文件的逻辑字符串进行校验，以将因为接口异常而出现的错误逻辑字符串进行校正，以实现最终的接口调用。

区别于现有技术，本申请提供的接口调用方法可以实现接口调用，且接口链接文件和接口调用文件可以重复调用，而不需要进行重复编写，接口调用方式较为便捷，对用户来说可以减少因接口重复调用而花费的时间。

参阅图4，图4是本申请提供的接口调用方法第四实施例的流程示意图，该方法包括：

步骤41：获取网页框架的第一配置文件中的配置对象。

步骤42：获取配置对象的目标字段。

步骤43：利用目标接口获取与目标字段对应的第二配置文件。

步骤44：基于第二配置文件，获取与目标接口对应的接口链接文件。

步骤45：基于接口调用规则，生成与接口链接文件对应的接口调用文件。

步骤41至步骤45可以与上述实施例具有相同或相似的技术方案，这里不做赘述。

步骤46：将接口调用文件显示在显示页面上。

在一些实施例中，用户可以在显示页面上选择对应接口调用文件，进而实现接口调用。

如，将不同的接口调用文件以待选择的形式显示在显示页面上，可以通过在显示页面上打勾的方式选中对应的接口调用文件，且通过勾选的方式可以直接利用该接口调用文件调用对应的接口。

如，将不同的接口调用文件进行封装，得到与各接口调用文件对应的按钮，可以通过在显示页面上点击响应的按钮，直接调用相应的接口。

区别于现有技术，本申请提供的接口调用方法通过获取网页框架的配置文件中的配置对象的目标字段，进而利用目标接口获取与目标字段对应的配置文件，以及基于与目标字段对应的配置文件获取与目标接口对应的接口链接文件和接口调用文件。

通过上述方式，可以实现接口调用，且可以将接口调用文件显示在显示页面上，实现通过显示页面直接调用对应接口的效果，且在可视化页面上显示的接口调用文件可以重复调用，而不需要进行重复编写，较为便捷，对用户来说可以减少因接口重复调用而花费的时间。

参阅图5，图5是本申请提供的接口调用设备一实施例的结构示意图，该接口调用设备50包括存储器501和处理器502，存储器501用于存储程序数据，处理器502用于执行程序数据以实现如上述任一实施例的接口调用方法，这里不再赘述。

参阅图6，图6是本申请提供的计算机可读存储介质一实施例的结构示意图，该计算机可读存储介质60存储有程序数据601，程序数据601在被处理器执行时，用于实现如上述任一实施例的接口调用方法，这里不再赘述。

本申请涉及的处理器可以称为CPU（Central Processing Unit，中央处理单元），可能是一种集成电路芯片，还可以是通用处理器、数字信号处理器（DSP）、专用集成电路（ASIC）、现场可编程门阵列（FPGA）或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。

本申请使用的存储介质包括U盘、移动硬盘、只读存储器（ROM，Read-OnlyMemory）、随机存取存储器（RAM，Random Access Memory）或者光盘等各种可以存储程序代码的介质。

以上所述仅为本申请的实施方式，并非因此限制本申请的专利范围，凡是利用本申请说明书及附图内容所作的等效结构或等效流程变换，或直接或间接运用在其他相关的技术领域，均同理包括在本申请的专利保护范围内。

Claims (6)

1.一种接口调用方法，其特征在于，所述方法包括：

获取网页框架的第一配置文件中的配置对象；

获取所述配置对象的目标字段；

基于所述目标字段，调用目标接口遍历文件库，以得到所述文件库中与所述目标字段对应的第二配置文件，其中所述第二配置文件为数据交换文件；其中，所述目标接口为API接口；

获取所述第二配置文件中与所述目标接口对应的接口链接信息；

基于目标容器，生成与所述接口链接信息对应的接口链接文件，其中所述目标容器为沙箱；

基于接口调用规则以及目标容器，生成与所述目标接口对应的接口调用文件；其中，所述接口调用规则为所述API接口对应的结构调用规则。

2.根据权利要求1所述的方法，其特征在于，所述网页框架为VueJS框架；

所述获取所述配置对象的目标字段，包括：

响应于调用所述配置对象的功能的调用指令，调用所述配置对象，以得到所述配置对象中的目标字段。

3.根据权利要求1所述的方法，其特征在于，

所述方法还包括：

对所述接口调用文件进行校验。

4.根据权利要求1所述的方法，其特征在于，

所述生成与所述接口链接文件对应的接口调用文件之后，所述方法还包括：

将所述接口调用文件显示在显示页面上。

5.一种接口调用设备，其特征在于，所述接口调用设备包括存储器和处理器，所述存储器存储有程序数据，所述处理器用于执行所述程序数据以实现如权利要求1-4任一项所述的方法。

6.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质存储有程序数据，所述程序数据在被处理器执行时用于实现如权利要求1-4任一项所述的方法。

Images