新手入门02-新建接口 · VirAPI官网 - 在线虚拟数据云接口平台

2020/08/19 11:08
阅读数 15

新手入门02-新建接口

于 2020-08-06发布在 VirAPI官网

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

本篇文章将详细介绍VirAPI创建应用的整体过程。

通过《新手入门01-创建应用》这篇文章我们介绍了VirAPI创建应用的过程。在成功创建了应用之后,即可创建虚拟数据接口了。直接进入【新建接口】(https://console.virapi.com/create_api)页,或者在应用详情页点击【新增接口】按钮进入。

VirAPI创建接口页截图

现在开始逐一介绍创建应用接口的各个填写项及细节。

选择目标应用

选中你所创建的目标应用,成功创建后的接口将归属在该应用下。

根据现实开发场景,数据接口都是在项目应用下,同一项目应用会有多个数据接口。居于此,所以建议把将同一应用场景项目下的数据接口都放在同一项目应用下。

接口名&接口URL

接口名主要用于方便快速识别及管理接口。接口名长度必须在2至36个字符以内。输入完接口名后,系统将自动根据接口名为您填写该接口的URI。若不是您想要的接口请求地址,可重置修改该接口URI。

接口URI:该接口最终请求的地址,其格式为https://api.virapi.com/{您的身份ID}/{应用标识代码}/{接口标记代码},其中身份ID可在个人详细页进行修改,但只支持修改一次,修改后将无法再次修改;应用标识代码是您创建对应应用时指定的,在创建应用成功后也无法修改编辑;接口标记代码则可在当前编辑框中自定义;仅支持字母数字及部分特殊符号。

此外,接口还支持动态路由,即URI中可定义变量参数;其中变量参数格式为{参数名};定义如:book/{id}category/{id?}news/{topic}/{id},其中在参数名后加上?即表示该参数可有可无。若定义的是动态路由,还支持对该参数进行数据类型限制,若请求时该参数不满足定义的数据规则,则该接口不会接收;具体如何定义动态路由参数的验证规则请见下文。

请求类型

大部分HTTP网络请求方式都集中在GETPOST请求上,但由于RESTful规范的指导(也建议大家在实际项目中采纳并遵守该规范),很多场景也会使用到诸如PUTDELETE的请求方式。VirAPI提供了该四种网络请求方式,即GETPOSTPUTDELETE;基本能满足所有场景的需要(根据实际需要后期也可能会扩展更多请求方式)。

请求参数

目前VirAPI提供了URL路由Body四种请求参数类型。

URL参数:即请求链接?号后拼接的请求参数;可手动定义预接收的该参数。

路由参数:若当前请求URI是动态路由URI,则才有该路由参数;该参数会自动从动态路由接口URI中自动识别出来。

Body参数:该参数只会在网络请求方式为POSTPUT时才有;可手动定义预接收的该参数。

对于请求参数,可定义其参数数据类型、是否必须、描述、及对于参数的请求验证规则。以URL参数为例:

VirAPI创建接口URI参数

点击“新增参数”即可创建新的URL参数;根据需要设置该参数的数据类型等规则要求,当请求接口时,若对于该请求参数数据不满足设定的规则时,则接口会返回失败,并提示数据验证非法。

对于动态路由接口,在路由参数将可见该动态路由中所定义的路由参数,如:

VirAPI动态路由参数

其中“是否必须”会根据动态路由参数后是否加有?来自动识别,如test_api/{id}表示在请求该接口时该id参数为必须的,而test_api/{id?}表示在请求该接口时该id参数可有可无。此外,路由参数还支持通过正则表达式来进一步限制该路由请求参数的数据格式;注意:不需要在正则前后加上斜杆符(/)。定义规则如: \d+

此外,对于URL参数Body数据,还可以详细定义对于请求参数的规则。如:

VirAPI Body数据参数规则

鼠标点击上图红框的按钮,则会弹出一个添加更多验证规则的编辑框。该编辑框里的对该参数的验证规则会根据其参数类型而不同。如字符串数组(array/string)类型:

VirAPI 编辑参数规则示例图

您可根据需要进行来决定是否需要设定验证规则及什么验证规则。

对于响应数据(data)

注意:此处返回数据特指返回数据的data部分,因api所属应用已创建了对应响应模板;即不需要再返回code及message部分。若无data内容可不编辑此项。

由于当前VirAPI虚拟数据生成方式及规则是使用MockJS来实现,即您可在该编辑框中使用MockJS语法自定义想要的目标数据结构。如:

VirAPI使用MockJS语法定义响应数据结构

关于MockJS在VirAPI上的使用,可参考《新手入门05-MockJS方法使用大全》这篇文章;或者也可参考MockJS官方文档案例

其他

接口创建成功后该接口即会出现在该应用下的【接口列表】页了。若需要修改编辑则可直接在页面中出来。


至此,VirAPI如何创建接口就介绍完了。如在使用过程中有遇到什么问题也欢迎大家通过Gitter与我们沟通和联系。

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部