VirAPI新手入门03-接口测试与使用

新手入门系列介绍文章：《新手入门01-创建应用》、《新手入门02-新建接口》、《新手入门03-接口测试与使用》、《新手入门04-应用高级管理》。

本篇文章将详细介绍VirAPI云数据虚拟接口在日常开发中如何接入及使用。

1. 前期准备介绍

要使用VirAPI虚拟在线接口，需要先创建应用并创建好对应虚拟接口，对应创建方式请参考：《新手入门01-创建应用》、《新手入门02-新建接口》。

当创建好应用及接口后，需确定当前应用接口API的请求地址、验证方式、以及 APP KEY。可登录VirAPI控制台，进入目标应用的详情页，在【应用信息】页可查阅，如：

在该示例中，可知应用接口的请求地址为https://api.virapi.com/ylsa222/demo，验证方式为兼容模式验证，而 APP KEY 即为请求该应用虚拟接口时的验证token。

关于请求验证规则，这里再次说明一下：验证方式即请求应用下虚拟数据生成接口时，用于验证请求权限的方式。当前提供三种验证规则：

• 请求头部Token验证：请求头部Header中附带一个名为【app-token】的报文数据；当设置为该验证规则时，需要请求虚拟接口时在请求头部Header中自定义一个名为app-token(大小写不限)的Header参数，系统将根据该数值来判断是否有权限访问该应用虚拟接口。
• 请求参数Token验证：请求路由请求参数中附带一个名为【_token】的GET请求参数；当设置为该验证规则时，需要请求虚拟接口时在请求链接URL后加上一个名为_token的Get路由参数，系统将根据该数值来判断是否有权限访问该应用虚拟接口。
• 兼容模式：(默认模式)兼容请求头部和请求参数验证规则，优先从请求头部中获取验证Token，若无则再从请求参数中获取。系统将优先采取请求头部Token验证，若未找到app-tokenHeader参数则继续在请求URL中寻找_token参数进行验证。

2. 确定要使用的接口

然后我们在已创建好的接口中（即点击页面左侧【所有接口】菜单进入对应标签页）挑选一个要测试或使用的接口。如：

通过该页面，我们可以快速找到我们要的虚拟接口，并获取到目标接口所定义的各项配置。

每个接口都有其请求的具体URL，可点击URL右侧的复制按钮，快速复制该接口的请求地址到粘贴板。

在这里可以看到该接口定义时的请求方式（如这里的POST），待会请求该接口时也就需要使用该请求方式去请求该虚拟接口URL。

请求参数栏会显示该接口所需要或者所定义的请求参数，主要可能有URL参数、路由参数、Body参数；因为该示例接口仅定义了Body参数，所以这里只出现Body参数数据表格。 通过该表格可知道当前接口接收的参数名、数据类型、是否必须、数据参数规则及参数描述。

3. 在线测试虚拟接口

每个接口卡片的右上角都会有“测试”、“编辑”、“删除”三个功能键。点击“测试”进入接口测试页面。

通过VirAPI提供的在线测试功能，直接输入需要传送的数据，然后发出测试请求即可看到请求结果。如提交了不符合自定义规则的参数：

以及请求参数合法，成功响应：

4. 远程请求虚拟接口

此处以PostMan为例，来介绍如何远程的所以VirAPI虚拟接口。

首先，输入API的请求地址，调整为POST请求方式；因为本示例的验证方式是兼容模式，可以在请求头部Header中定义app-token或在URL后接参数_token，此处采用Header提交token验证方式。即配置效果如下图：

如何再配置请求参数Body参数，先来测试Body参数不符合该接口定义的规则时，请求的响应：

因为该接口定义时限制了必须附带id请求参数，此时请求未带id参数即响应得到错误提示结果数据。

再来看看提交正确的请求参数时，数据的响应返回：

若该虚拟接口定义了响应返回的data数据，则还会返回通过mockjs随机生成的虚拟数据，如：

5. 总结

在实际项目中，如Web页面、APP、小程序等客户端，也一样是这个流程，即

• 确定虚拟接口请求地址
• 确定接口的请求方式（GET、POST、PUT、DELETE）
• 依据定义的验证方式，在请求头部Header添加app-token或在请求URL添加_token，用来验证请求身份合法性
• 如果有请求参数，则输入请求参数

然后发起请求即可。

至此，VirAPI的虚拟云数据接口测试与使用介绍完毕。如在使用过程中有遇到什么问题也欢迎大家通过Gitter与我们沟通和联系。