资讯专栏INFORMATION COLUMN

faked 一个用于 mock 后端 API 的轻量工具

wind3110991 / 3190人阅读

摘要:一简介是一个在前端开发中用于服务端接口的模块,轻量简单,无需要在本地启动也无需其它更多的资源,仅在浏览器中完成请求拉截,配合完整的路由系统轻而易举的后端。

一、简介

faked 是一个在前端开发中用于 mock 服务端接口的模块,轻量简单,无需要在本地启动 Server 也无需其它更多的资源,仅在浏览器中完成「请求拉截」,配合完整的「路由系统」轻而易举的 mock 后端 API。

GitHub Rep 地址:https://github.com/Houfeng/faked

二、安装 faked

有两种可选安装方式,你可以通过传统的 sciprt 方式引入 faked,如果你采用了 CommonJs 或 ES6 Modules 模块方案,也可通过安装 NPM Pageage 的方式安装依赖。

通过 script 引入:

通过 npm 安装:

$ npm i faked --save-dev

CommonJs 方式引用

const faked = require("faked");

ES6 Modules 方式引用

import faked from "faked"
三、基本使用

通过 faked.when 方法你几乎就可以使用 faked 的所有功能了,尽管 faked 还提供了一组「快捷方法」,faked.when 方法说明如下:

//指定单一 Http Method
faked.when(, , );

//指定多个 Http Method
faked.when(, , );

示例,模拟一个获取用户信息的接口,参考如下代码:

faked.when("get","/user/{id}", function(){
  this.send({name:"Bob"});
});

每一个 handlerthis 就是当前请求上下文对象,对象有如下主要成员:

this.send(data, status, headers) 方法,用于响应一个请求,status 默认为 200

this.params 路由参数对象,用于访问路由模式中的「路由参数」,如上边示例中的 id

this.query 解析查询字符串对应的对象,比如 ?name=bob 可以通过 this.query.name 访问

this.body 请求的主体内容,通常会是一个 json 对象,它取决于发起的请求。

除了使用 send 方法,还可以直接「返回」数据,参考如下代码:

faked.when("get","/user/{id}", function(){
  return {name:"Bob"};
});

当然,在有「异步处理」时你也可以返回一个 promise 对象或像上边那样用 send 方法。如果你只想 mock 数据,还可以使用简化写法,参考如下代码:

faked.when("get","/user/{id}", {name:"bob"});
四、快捷方法

faked 还基于 when 方法提供了一组快捷方法,对应常用的 Http Methods,包括:

get, post, put, delete, options, patch, head, copy, link, unlink, lock, unlock, view

faked.get 写一个示例:

faked.get("/user/{id}",function(){
  this.send({name:"Bob"});
});

其它快捷方法和 faked.get 用法完全一致。

五、路由系统

在编辑 Mock API 时, faked 提供了路由支持,如上边看到的 /user/{id},就是一个路由「匹配模式」,其中 {id} 是一个路由参数,当多个路由同时匹配请求的 URL 时,只会触发第一个执行,不同的 Http Method 的 URL 匹配模式可以相同,并不会冲突。路由参数还可以加「限定表达式」,参考如下代码:

// User Id 只能是数字
faked.get("/user/{id:d+}", {name:"test"});
六、模拟网络延时

有时候,我们希望 Mock API 能延时响应数据,以模拟「网络延时」,faked 目前支持固定的「延时设置」,参考如下代码:

const faked = require("faked");

//所有的请求都将被延时 2 秒种再响应用 mock 数据
faked.delay = 2000; 

当 delay 设置 0 时,将禁用延时。

七、设置超时时间

faked 还可设置 Mock API 的最大响应时间,这项设置存在的意义还在于「所有 Mock API 的 Handler 默认都是异步的,如果忘记「返回或 Send」一个响应结果,请求将会被一直挂起,有了超时设置,超时时将会抛出一个错误,方便定位问题」,参考如下代码:

const faked = require("faked");

//在超过 8 秒未响应数据时,将会打印一个错误消息
faked.timeout = 8000; 

超时设置和延时设置并不会相互影响,超时计算是从延时结束后开始的。

八、JSONP 处理

faked 除了能 mock 常规的 ajaxfetch 请求,还能 mock 常常用来处理跨域问题的 jsonp 请求,faked 有两个参数用于配置 jsonp,参考如下代码:

//指定服务端用于获取「回调函数名」的 「QueryString 参数」
faked.jsonp.param = "callback"; //默认值为 callback 和 jQuery 一致

//有些 jsonp 服务可能是固定了「回调函数名」,可以这样设定
faked.jsonp.callback = "your-callbak-name"; 
九、注意事项

faked 是一个「辅助开发」的工具,除非有特殊需要,一般情况下它不应出现在你的生产代码中,所以需要注意:

请勿将 faked 放到「生产环境」的应用或页面中

找一个合适的你项目的方式决定什么时引用 faked

比如,在 webpak 中,可以根据环境变量决定入口文件,并只在 mock 的入口文件中引用 faked,示例:

webpack.config.js

module.exports = {
  entry: {
    //根据 NODE_ENV 决定是 index.js 还是 index.mock.js
    bundle: `./src/index${NODE_ENV=="mock"?".mock":""}.js`
  },
  output: {
    path: "./dist/",
    filename: `./[name]${NODE_ENV == "prod"?".min":""}.js`
  },
  devtool: "source-map",
  module: {
    loaders: [...]
  },
  plugins: [...]
};

然后,在 index.mock.js 中这样写:

require("./mock")
require("./index");

用于存放的 mock 代码的 mock.js 可能是这样的:

const faked = require("faked");

faked.get("/user/{id}",function(){
  this.send({name:"Bob"});
});

当然,你可以根据实际情况,安排你的文或目录结构。

-- END --

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/82173.html

相关文章

  • mock service系列】Online mock service or API by Sand

    摘要:沙箱,第一反应,但并不是。为避免误解,下文中所有提到都是指这个工具,不是沙箱。做什么的,根据其官网上的描述可以理解为快速生成,即时部署,协作构建并集成了调试工具。对个人而言,强烈推荐给入门的人。 Sandbox--沙箱,第一反应,但sorry并不是。 sandbox 这个词大家并不陌生,但貌似国内的技术share中很少看到有提到这个工具的。为避免误解,下文中所有提到sandbox都是指...

    zgbgx 评论0 收藏0
  • 用Jasmine和Sinon测试Backbone应用 (译)

    摘要:框架本身可以很好地支持自下而上的单元测试。在中,这些原因可以分为性能真实的操作,依靠定时行为及网络活动减慢了测试隔离单元测试应把重点放在小的一块功能成为可能,并解耦不可靠的或低依赖使用对象是拥抱和的基本组成部分。 最近在慢慢深入Backbone,也试着写一些测试,找一些合适的文档来学习。于是就找到了一个系列的文章 : Testing Backbone applications with...

    ralap 评论0 收藏0
  • 前端单元测试初探

    摘要:本文只讨论单测的范畴,对集成测试有兴趣的话,可以看下的集成测试代码。前端单测现状测试本质上就是假定一个输入,然后判断得到预期的输出。 原文发于我的博客:https://github.com/hwen/blogS... 要不要写单测? 关于这个 cnode 上就有个很有意思的讨论 做个调查,你的 Node 应用有写单测吗? 看完这个应该会有结论?如果没有,就回帖跟别人探讨下~ 测试 测试...

    isLishude 评论0 收藏0
  • 前端每周清单第 13 期:Webpack CLI 发布、解密现代浏览器引擎构建之道

    摘要:前端每周清单第期前端每周清单发布可期待的新特性解密现代浏览器引擎构建之道前端前端每周清单前端每周清单专注前端领域内容,分为新闻热点开发教程工程实践深度阅读开源项目巅峰人生等栏目。该过程可用于确定出现变更的具体时间,并将变更传递给渲染器。 前端每周清单第 13 期:Webpack CLI 发布、Angular 5 可期待的新特性、解密现代浏览器引擎构建之道 为InfoQ中文站特供稿件,首...

    kuangcaibao 评论0 收藏0
  • 使用API自动生成工具优化前端工作流

    摘要:在工作中,我们的前端工作流一般开始于前后端协商好文档之后,再针对这个文档做模拟数据,然后用做好的进行开发,后端开发完毕之后再改一下数据的切换到正式进行联调如下本文介绍的一个工具或者说方法,来将这个工作流优化一下,也是我平时工作正在用的方法, 在工作中,我们的前端工作流一般开始于前后端协商好Api文档之后,再针对这个Api文档做mock模拟数据,然后用做好的mock进行开发,后端开发完毕...

    GeekQiaQia 评论0 收藏0

发表评论

0条评论

wind3110991

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<