一、简介

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

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

二、安装 faked

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

通过 script 引入:

<script src="your-path/faked.min.js"></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(<method>, <pattern>, <handler>); //指定多个 Http Method
faked.when(<methods>, <pattern>, <handler>);

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

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

  1. 请勿将 faked 放到「生产环境」的应用或页面中
  2. 找一个合适的你项目的方式决定什么时引用 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 --

faked 一个用于 mock 后端 API 的轻量工具的更多相关文章

  1. Cardinal:一个用于移动项目开发的轻量 CSS 框架

    Cardinal 是一个适用于移动项目的 CSS 框架,包含很多有用的默认样式.矢量字体.可重用的模块以及一个简单的响应式模块系统.Cardinal 提供了一种在多种移动设备上实现可伸缩的字体和布局的 ...

  2. ASP.NET Core 3.0 一个 jwt 的轻量角色/用户、单个API控制的授权认证库

    目录 说明 一.定义角色.API.用户 二.添加自定义事件 三.注入授权服务和中间件 三.如何设置API的授权 四.添加登录颁发 Token 五.部分说明 六.验证 说明 ASP.NET Core 3 ...

  3. CYQ.Data 轻量数据层之路 优雅V1.4 现世 附API帮助文档(九)

    继上一版本V1.3版本发布到现在,时隔N天了:[V1.3版本开源见:CYQ.Data 轻量数据层之路 华丽V1.3版本 框架开源] N天的时间,根据各路网友的反映及自身的想法,继续修改优化着本框架,力 ...

  4. [原创]一种专门用于前后端分离的web服务器(JerryServer)

    如果你还不了解现在的前后端分离,推荐阅读淘宝前端团队的前后端分离的思考与实践 1.问题 随着现在整个软件开发行业的发展,在开发模式上逐渐由以前的一个人完成服务端和前端web页面,演变为前端和后端逐渐分 ...

  5. 微信小程序开发——使用mock数据模拟api请求

    前言: 微信小程序开发中,后端提供了接口设计文档,前端可以先mock数据模拟api请求进行开发调试,而且可以根据需要设计mock文件的格式和内容,这样在后端接口开发完成之前,前端可以最大限度的完成前端 ...

  6. 从零开始学习 asp.net core 2.1 web api 后端api基础框架(二)-创建项目

    原文:从零开始学习 asp.net core 2.1 web api 后端api基础框架(二)-创建项目 版权声明:本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.ne ...

  7. 如何设计一个牛逼的API接口

    在日常开发中,总会接触到各种接口.前后端数据传输接口,第三方业务平台接口.一个平台的前后端数据传输接口一般都会在内网环境下通信,而且会使用安全框架,所以安全性可以得到很好的保护.这篇文章重点讨论一下提 ...

  8. 如何使用 Python 编写后端 API 接口

    如何使用 Python 编写后端 API 接口 get API Python3 # coding:utf-8 import json # ModuleNotFoundError: No module ...

  9. 使用egg.js开发后端API接口系统

    什么是Egg.js Egg.js 为企业级框架和应用而生,我们希望由 Egg.js 孕育出更多上层框架,帮助开发团队和开发人员降低开发和维护成本.详细的了解可以参考Egg.js的官网:https:// ...

随机推荐

  1. DNS之XX记录

    DNS服务器里有两个比较重要的记录.一个叫SOA记录(起始授权机构) 一个叫NS(Name Server)记录(域名服务器)关于这两个记录,很多文章都有解释,但是很多人还是很糊涂.我现在通俗的解释一下 ...

  2. [ JS 进阶 ] Repaint 、Reflow 的基本认识和优化

    你是不是经常听师兄或一些前端前辈说不能用CSS通配符 *,CSS选择器层叠不能超过三层,CSS尽量使用类选择器,书写HTML少使用table,结构要尽量简单-DOM树要小....等这些忠告,以前我就大 ...

  3. ORA-**,oracle 12c操作问题

    https://blog.csdn.net/typa01_kk/article/details/41924321

  4. Canvas进阶——制作小游戏【贪吃蛇】

    今天呢,主要和小伙伴们分享一下一个贪吃蛇游戏从构思到实现的过程~因为我不是很喜欢直接PO代码,所以只copy代码的童鞋们请出门左转不谢. 按理说canvas与其应用是老生常谈了,可我在准备阶段却搜索不 ...

  5. 在LoadRunner中从数组类型的参数随机取值的方法

    在LoadRunner中从数组类型的参数随机取值的方法 使用web_reg_save_param做关联后,有时候会有多个匹配值. 为了模仿用户行为随机取一个值为后续transcation所用,可以使用 ...

  6. Wannafly挑战赛18 C - 异或和

    思路:我刚开始是想旋转四次坐标,每次用bit计算每个点左上角的点到这个点的距离,TLE了.... 这种算曼哈顿距离的可以将x 轴和 y 轴独立开来,分别计算. #include<bits/std ...

  7. 哈尔滨理工大学第七届程序设计竞赛决赛(网络赛-高年级组)I - 没有名字

    题目描述 tabris实在是太菜了,没打败恶龙,在绿岛也只捡到一块生铁回去了,为了不在继续拉低acimo星球的平均水平逃离地球,来到了Sabi星球. 在这里tabris发现了一种神奇的生物,这种生物不 ...

  8. here with you

    Here With You - Asher Book To all my friends对我所有好友来讲The night is young夜未央The music's loud乐未殇They pla ...

  9. Vue 2.0学习(三)指令与事件

    指令(Directives)是Vue.js模板中最常用的一项功能,它带有前缀v-,前面已经使用过v-html.v-pre等.指令的主要职责就是当表达式的值改变时,相应地将某些行为应用到DOM上. v- ...

  10. ubuntu16.04.2安装完后重启报错[sda] Assuming drive cache: write through

    原因:检测主机的物理连接线,发生问题时"已连接"未勾选,重启的时候找不到iso文件 解决办法:勾选"已连接",重启机器成功