写点什么

比 POSTMAN 更好用!在国产接口调试工具 APIPOST 中使用 Mock

用户头像
Proud lion
关注
发布于: 2021 年 08 月 27 日

APIPOST 可以让你在没有后端程序的情况下能真实地返回接口数据,你可以用 APIPOST 实现项目初期纯前端的效果演示,也可以用 APIPOST 实现开发中的数据模拟从而实现前后端分离。在使用 APIPOST 之前,你的团队实现数据模拟可能是下面的方案中的一种或者多种:


  • 本地手写数据模拟,在前端代码中产生一大堆的 mock 代码。

  • 利用 mockjs 或者 canjs 的 can-fixture 实现 ajax 拦截,本地配置必要的 json 规则。

  • 后端在 Controller 层造假数据返回给前端。


上面的方式中,不管哪一种方式,都会要求开发人员写一些跟项目本无任何关联的代码,第一个和第二个方式还会需要前端项目在本地引入不必要的 js 文件。

使用 APIPOST 的 Mock 服务

您可以通过 APIPOST 提供的 Mock 服务实现上述功能。

编写 Mock 规则


在 APIPOST 中,Mock 规则模板支持类型丰富(5.4 版本起)。

基本数据(固定 json 结构)

{  "code": "0",  "data": {    "name": "张三丰",    "age": 100  },  "desc": "成功"}
复制代码

基本数据(Mock 随机 json 结构)

{  "code": "0",  "data": {    "list|20": [{      "name": "@name",      "age": "@integer(2)"    }],    "url": "https://echo.apipost.cn"  },  "desc": "成功"}
复制代码

RESTFUL 逻辑数据

某些场景中,我们可能需要根据接口的入参规则,加入适当的逻辑处理后再返回数据。一个简单的场景就是登录场景,需要根据用户名密码,判断是否登录成功。再或者,我们需要根据产品 ID 动态返回产品信息,等等。


现在,ApiPost 的 Mock 服务提供了这种场景的解决方案。以下示例中,我们用到了 _req.body 对象,其含义是:


当 post 请求以 x-www-form-urlencoded 或者 application/json 方式提交时,我们可以拿到请求的参数对象。


{  "code": "0000",  "data": {    "verifySuccess": function() {      let body = _req.body;      return body.username === 'admin' && body.password === '123456';    },    "userInfo": function() {      let body = _req.body;      if (body.username === 'admin' && body.password === '123456') {        return Mock.mock({          username: "admin",          email: "@email",          address: "@address"        });      } else {        return null;      }    },  },  "desc": "成功"}
复制代码

填写 Mock URL 相对地址

Mock URL 相对地址是必填项(如果不填写的话,无法正常得到响应结果)。您可以通过在设置里开启“自动获取 Mock URL 地址”来自动获取 Mock URL。



此项开启后,APIPOST 将根据您输入的接口 URL 自动截取 PATH 部分作为 Mock URL 的相对路径。

利用 APIPOST 发送 Mock URL

完成以上 2 步后,您可以通过在 APIPOST 中切换到“Mock 环境”来发送查看 mock 返回的详细数据。


将生成的 mock URL 地址发给前端


您可以将 APIPOST 生成的 mock URL 地址发给前端来代替您的接口地址,这样前端就可以使用您模拟的数据进行先一步的调试开发了。当您的接口完成后,再替换回来即可。


APIPOST 的 mock 是基于 mock.js 开发的。具体文档可以 参见 mock.js 详细文档。

用户头像

Proud lion

关注

还未添加个人签名 2021.08.16 加入

还未添加个人简介

评论

发布
暂无评论
比POSTMAN更好用!在国产接口调试工具APIPOST中使用Mock