脚本宝典收集整理的这篇文章主要介绍了

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

脚本宝典小编觉得挺不错的,现在分享给大家,也给大家做个参考,希望能帮助你少写一行代码,多一份安全和惬意。
<p><code></p> <p><span class="img-wrap"><img data-src="/img/remote/1460000008811980?w=800&amp;h=200" src="/img/remote/1460000008811980?w=800&amp;h=200" alt="logo" title="logo" style="cursor: pointer; display: inline;"></span></p> <h2 id="articleHeader0">一、简介</h2> <p>faked 是一个在前端开发中用于 mock 服务端接口的模块,轻量简单,无需要在本地启动 Server 也无需其它更多的资源,仅在浏览器中完成「请求拉截」,配合完整的「路由系统」轻而易举的 mock 后端 <a href="http://www.js-code.com/tag/api" title="API" target="_blank">API</a>。</p> <p>GitHub Rep 地址:<a href="https://github.com/Houfeng/faked" rel="nofollow noreferrer" target="_blank">https://github.com/Houfeng/faked</a></p> <h2 id="articleHeader1">二、安装 faked</h2> <p>有两种可选安装方式,你可以通过传统的 <code>sciprt</code> 方式引入 faked,如果你采用了 CommonJs 或 ES6 Modules 模块方案,也可通过安装 NPM Pageage 的方式安装依赖。</p> <p>通过 script 引入:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="<a href="http://www.js-code.com/tag/button" title="button" target="_blank">button</a>" <a href="http://www.js-code.com/tag/class" title="class" target="_blank">class</a>="copyCode code-tool" data-toggle="tooltip" data-placement="<a href="http://www.js-code.com/tag/top" title="top" target="_blank">top</a>" data-clipboard-<a href="http://www.js-code.com/tag/text" title="text" target="_blank">text</a>="<script src=&quot;your-path/faked.min.js&quot;></script>" title="" data-original-title="复制"></span> </div> </p></div> <pre class="xml hljs"><code class="html" style="word-break: break-word; white-space: initial;"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"your-path/faked.m<a href="http://www.js-code.com/tag/in" title="浏览关于“in”的文章" target="_blank" class="tag_link">in</a>.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre> <p>通过 npm 安装:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="$ npm i faked --save-dev" title="" data-original-title="复制"></span> </div> </p></div> <pre class="hljs sql"><code class="sh" style="word-break: break-word; white-space: initial;">$ npm i faked <span class="hljs-comment">--save-dev</span></code></pre> <p>CommonJs 方式引用</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="const faked = require('faked');" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js" style="word-break: break-word; white-space: initial;"><span class="hljs-keyword"><a href="http://www.js-code.com/tag/const" title="浏览关于“const”的文章" target="_blank" class="tag_link">const</a></span> faked = <span class="hljs-built_in">require</span>(<span class="hljs-string">'faked'</span>);</code></pre> <p>ES6 Modules 方式引用</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="import faked from 'faked'" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js" style="word-break: break-word; white-space: initial;"><span class="hljs-keyword">import</span> faked <span class="hljs-keyword">from</span> <span class="hljs-string">'faked'</span></code></pre> <h2 id="articleHeader2">三、基本使用</h2> <p>通过 <code>faked.when</code> 方法你几乎就可以使用 faked 的所有功能了,尽管 faked 还提供了一组「快捷方法」,<code>faked.when</code> 方法说明如下:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="<a href="http://www.js-code.com/tag/button" title="button" target="_blank">button</a>" <a href="http://www.js-code.com/tag/class" title="class" target="_blank">class</a>="copyCode code-tool" data-toggle="tooltip" data-placement="<a href="http://www.js-code.com/tag/top" title="top" target="_blank">top</a>" data-clipboard-<a href="http://www.js-code.com/tag/text" title="text" target="_blank">text</a>="//指定单一 Http Method<br /> faked.when(<method>, <pattern>, <handler>);</p> <p>//指定多个 Http Method<br /> faked.when(<methods>, <pattern>, <handler>);" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-comment">//指定单一 Http Method</span> faked.when(&lt;method&gt;, &lt;pattern&gt;, &lt;handler&gt;); //指定多个 Http Method faked.when(&lt;methods&gt;, &lt;pattern&gt;, &lt;handler&gt;);</code></pre> <p>示例,模拟一个获取用户信息的接口,参考如下代码:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="faked.when('get','/user/{id}', function(){ this.send({name:'Bob'}); });" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js">faked.when(<span class="hljs-string">'get'</span>,<span class="hljs-string">'/user/{id}'</span>, <span class="hljs-function"><span class="hljs-keyword"><a href="http://www.js-code.com/tag/function" title="浏览关于“function”的文章" target="_blank" class="tag_link">function</a></span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-keyword"><a href="http://www.js-code.com/tag/this" title="浏览关于“this”的文章" target="_blank" class="tag_link">this</a></span>.send({<span class="hljs-attr"><a href="http://www.js-code.com/tag/name" title="浏览关于“name”的文章" target="_blank" class="tag_link">name</a></span>:<span class="hljs-string">'Bob'</span>}); });</code></pre> <p>每一个 <code>handler</code> 的 <code><a href="http://www.js-code.com/tag/this" title="this" target="_blank">this</a></code> 就是当前请求上下文对象,对象有如下主要成员:</p> <ul> <li> <p><code><a href="http://www.js-code.com/tag/this" title="this" target="_blank">this</a>.send(data, <a href="http://www.js-code.com/tag/status" title="status" target="_blank">status</a>, headers)</code> 方法,用于响应一个请求,<a href="http://www.js-code.com/tag/status" title="status" target="_blank">status</a> 默认为 200</p> </li> <li> <p><code><a href="http://www.js-code.com/tag/this" title="this" target="_blank">this</a>.params</code> 路由参数对象,用于访问路由模式中的「路由参数」,如上边示例中的 id</p> </li> <li> <p><code><a href="http://www.js-code.com/tag/this" title="this" target="_blank">this</a>.query</code> 解析查询字符串对应的对象,比如 <code>?<a href="http://www.js-code.com/tag/name" title="name" target="_blank">name</a>=bob</code> 可以通过 <code><a href="http://www.js-code.com/tag/this" title="this" target="_blank">this</a>.query.<a href="http://www.js-code.com/tag/name" title="name" target="_blank">name</a></code> 访问</p> </li> <li> <p><code><a href="http://www.js-code.com/tag/this" title="this" target="_blank">this</a>.body</code> 请求的主体内容,通常会是一个 <code>json</code> 对象,它取决于发起的请求。</p> </li> </ul> <p>除了使用 <code>send</code> 方法,还可以直接「返回」数据,参考如下代码:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="faked.when('get','/user/{id}', function(){ return {name:'Bob'}; });" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js">faked.when(<span class="hljs-string">'get'</span>,<span class="hljs-string">'/user/{id}'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-keyword"><a href="http://www.js-code.com/tag/return" title="浏览关于“return”的文章" target="_blank" class="tag_link">return</a></span> {<span class="hljs-attr">name</span>:<span class="hljs-string">'Bob'</span>}; });</code></pre> <p>当然,在有「异步处理」时你也可以返回一个 <code>promise</code> 对象或像上边那样用 <code>send</code> 方法。如果你只想 mock 数据,还可以使用简化写法,参考如下代码:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="faked.when('get','/user/{id}', {name:'bob'});" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js" style="word-break: break-word; white-space: initial;">faked.when(<span class="hljs-string">'get'</span>,<span class="hljs-string">'/user/{id}'</span>, {<span class="hljs-attr">name</span>:<span class="hljs-string">'bob'</span>});</code></pre> <h2 id="articleHeader3">四、快捷方法</h2> <p>faked 还基于 when 方法提供了一组快捷方法,对应常用的 Http Methods,包括:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="get, post, put, delete, options, patch, head, copy, link, unlink, lock, unlock, view" title="" data-original-title="复制"></span> </div> </p></div> <pre class="hljs sql"><code style="word-break: break-word; white-space: initial;">get, post, put, <span class="hljs-keyword"><a href="http://www.js-code.com/tag/delete" title="浏览关于“delete”的文章" target="_blank" class="tag_link">delete</a></span>, <a href="http://www.js-code.com/tag/option" title="浏览关于“option”的文章" target="_blank" class="tag_link">option</a>s, <span class="hljs-keyword">patch</span>, <span class="hljs-keyword">head</span>, copy, <span class="hljs-keyword"><a href="http://www.js-code.com/tag/link" title="浏览关于“link”的文章" target="_blank" class="tag_link">link</a></span>, unlink, <span class="hljs-keyword">lock</span>, <span class="hljs-keyword">unlock</span>, <span class="hljs-keyword">view</span></code></pre> <p>用 <code>faked.get</code> 写一个示例:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="faked.get('/user/{id}',function(){ this.send({name:'Bob'}); });" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js">faked.get(<span class="hljs-string">'/user/{id}'</span>,<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-keyword">this</span>.send({<span class="hljs-attr">name</span>:<span class="hljs-string">'Bob'</span>}); });</code></pre> <p>其它快捷方法和 <code>faked.get</code> 用法完全一致。</p> <h2 id="articleHeader4">五、路由系统</h2> <p>在编辑 Mock <a href="http://www.js-code.com/tag/api" title="API" target="_blank">API</a> 时, faked 提供了路由支持,如上边看到的 <code>/user/{id}</code>,就是一个路由「匹配模式」,其中 <code>{id}</code> 是一个路由参数,当多个路由同时匹配请求的 URL 时,只会触发第一个执行,不同的 <code>Http Method</code> 的 URL 匹配模式可以相同,并不会冲突。路由参数还可以加「限定表达式」,参考如下代码:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="// User Id 只能是数字 faked.get('/user/{id:d+}', {name:'test'});" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-comment">// User Id 只能是数字</span> faked.get(<span class="hljs-string">'/user/{id:d+}'</span>, {<span class="hljs-attr">name</span>:<span class="hljs-string">'test'</span>});</code></pre> <h2 id="articleHeader5">六、模拟网络延时</h2> <p>有时候,我们希望 Mock <a href="http://www.js-code.com/tag/api" title="浏览关于“API”的文章" target="_blank" class="tag_link">API</a> 能延时响应数据,以模拟「网络延时」,faked 目前支持固定的「延时设置」,参考如下代码:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="const faked = require('faked'); //所有的请求都将被延时 2 秒种再响应用 mock 数据 faked.delay = 2000; " title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-keyword">const</span> faked = <span class="hljs-built_in">require</span>(<span class="hljs-string">'faked'</span>); <span class="hljs-comment">//所有的请求都将被延时 2 秒种再响应用 mock 数据</span> faked.delay = <span class="hljs-number">2000</span>; </code></pre> <p>当 delay 设置 0 时,将禁用延时。</p> <h2 id="articleHeader6">七、设置超时时间</h2> <p>faked 还可设置 Mock API 的最大响应时间,这项设置存在的意义还在于「所有 Mock API 的 Handler 默认都是异步的,如果忘记「返回或 Send」一个响应结果,请求将会被一直挂起,有了超时设置,超时时将会抛出一个错误,方便定位问题」,参考如下代码:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="const faked = require('faked'); //在超过 8 秒未响应数据时,将会打印一个错误消息 faked.timeout = 8000; " title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-keyword">const</span> faked = <span class="hljs-built_in">require</span>(<span class="hljs-string">'faked'</span>); <span class="hljs-comment">//在超过 8 秒未响应数据时,将会打印一个错误消息</span> faked.timeout = <span class="hljs-number">8000</span>; </code></pre> <p>超时设置和延时设置并不会相互影响,超时计算是从延时结束后开始的。</p> <h2 id="articleHeader7">八、JSONP 处理</h2> <p>faked 除了能 mock 常规的 <code>ajax</code> 和 <code>fetch</code> 请求,还能 mock 常常用来处理跨域问题的 <code>jsonp</code> 请求,faked 有两个参数用于配置 jsonp,参考如下代码:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="//指定服务端用于获取「回调函数名」的 「QueryString 参数」 faked.jsonp.param = 'callback'; //默认值为 callback 和 jQuery 一致 //有些 jsonp 服务可能是固定了「回调函数名」,可以这样设定 faked.jsonp.callback = 'your-callbak-name'; " title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-comment">//指定服务端用于获取「回调函数名」的 「Query<a href="http://www.js-code.com/tag/String" title="浏览关于“String”的文章" target="_blank" class="tag_link">String</a> 参数」</span> faked.jsonp.param = <span class="hljs-string">'c<a href="http://www.js-code.com/tag/all" title="浏览关于“all”的文章" target="_blank" class="tag_link">all</a>back'</span>; <span class="hljs-comment">//默认值为 callback 和 <a href="http://www.js-code.com/tag/jquery" title="浏览关于“jQuery”的文章" target="_blank" class="tag_link">jQuery</a> 一致</span> <span class="hljs-comment">//有些 jsonp 服务可能是固定了「回调函数名」,可以这样设定</span> faked.jsonp.callback = <span class="hljs-string">'your-callbak-name'</span>; </code></pre> <h2 id="articleHeader8">九、注意事项</h2> <p>faked 是一个「辅助开发」的工具,除非有特殊需要,一般情况下它不应出现在你的生产代码中,所以需要注意:</p> <ol> <li> <p>请勿将 faked 放到「生产环境」的应用或页面中</p> </li> <li> <p>找一个合适的你项目的方式决定什么时引用 faked</p> </li> </ol> <p>比如,在 <code>webpak</code> 中,可以根据环境变量决定入口文件,并只在 <code>mock</code> 的入口文件中引用 faked,示例:</p> <p>webpack.config.js</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="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: [...] };" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-built_in">module</span>.<a href="http://www.js-code.com/tag/export" title="浏览关于“export”的文章" target="_blank" class="tag_link">export</a>s = { <span class="hljs-attr">en<a href="http://www.js-code.com/tag/try" title="浏览关于“try”的文章" target="_blank" class="tag_link">try</a></span>: { <span class="hljs-comment">//根据 NODE_ENV 决定是 index.js 还是 index.mock.js</span> bundle: <span class="hljs-string">`./src/index<span class="hljs-subst">${NODE_ENV==<span class="hljs-string">'mock'</span>?<span class="hljs-string">'.mock'</span>:<span class="hljs-string">''</span>}</span>.js`</span> }, <span class="hljs-attr">output</span>: { <span class="hljs-attr">path</span>: <span class="hljs-string">'./dist/'</span>, <span class="hljs-attr">filename</span>: <span class="hljs-string">`./[name]<span class="hljs-subst">${NODE_ENV == <span class="hljs-string">'prod'</span>?<span class="hljs-string">'.min'</span>:<span class="hljs-string">''</span>}</span>.js`</span> }, <span class="hljs-attr">devtool</span>: <span class="hljs-string">'source-map'</span>, <span class="hljs-attr">module</span>: { <span class="hljs-attr">loaders</span>: [...] }, <span class="hljs-attr"><a href="http://www.js-code.com/tag/plugin" title="浏览关于“plugin”的文章" target="_blank" class="tag_link">plugin</a>s</span>: [...] };</code></pre> <p>然后,在 <code><a href="http://www.js-code.com/tag/in" title="in" target="_blank">in</a>dex.mock.js</code> 中这样写:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="require('./mock') require('./index');" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-built_in">require</span>(<span class="hljs-string">'./mock'</span>) <span class="hljs-built_in">require</span>(<span class="hljs-string">'./index'</span>);</code></pre> <p>用于存放的 <code>mock</code> 代码的 <code>mock.js</code> 可能是这样的:</p> <div class="widget-codetool" style="display:none;"> <div class="widget-codetool--inner"> <span class="selectCode code-tool" data-toggle="tooltip" data-placement="top" title="" data-original-title="全选"></span><br /> <span type="button" class="copyCode code-tool" data-toggle="tooltip" data-placement="top" data-clipboard-text="const faked = require('faked'); faked.get('/user/{id}',function(){ this.send({name:'Bob'}); });" title="" data-original-title="复制"></span> </div> </p></div> <pre class="javascript hljs"><code class="js"><span class="hljs-keyword">const</span> faked = <span class="hljs-built_in">require</span>(<span class="hljs-string">'faked'</span>); faked.get(<span class="hljs-string">'/user/{id}'</span>,<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-keyword">this</span>.send({<span class="hljs-attr">name</span>:<span class="hljs-string">'Bob'</span>}); });</code></pre> <p>当然,你可以根据实际情况,安排你的文或目录结构。</p> <p>-- END --</p> <p></code></p>

总结

以上是脚本宝典为你收集整理的

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

全部内容,希望文章能够帮你解决

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

所遇到的程序开发问题,欢迎加入QQ群277859234一起讨论学习。如果觉得脚本宝典网站内容还不错,欢迎将脚本宝典网站推荐给程序员好友。 本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。

80%的人都看过