专栏首页趣谈前端5分钟教你用nodeJS手写一个mock数据服务器

5分钟教你用nodeJS手写一个mock数据服务器

对于前端开发者而言,javascript正扮演着越来越重要的地位,它不仅能为浏览器端赋能,在web服务器方面也有很大的价值(我们可以用nodeJS来写服务端代码,启动web服务器),因此本文所要描述的,便是javascript在服务端的应用。我将介绍如何使用nodeJS来搭建一个mock服务器,方便前端自定义mock数据请求,提高前端开发的主观能动性和对项目健壮性的探索。

我们将学到

  • koa基本使用
  • koa-router的基本用法
  • koa-logger的使用
  • glob支持文件遍历查寻
  • node几个核心api的使用
  • 使用nodemon做自动重启

mock服务器基本设计思路

通过目录路径和服务端api的映射关系来实现我们的api访问,比如我们访问接口/api/article/122,我们只需要在mock服务器目录的api的article目录下,创建122.json文件即可,json文件的数据可以自定义,方便前端调试。

具体实现

1.搭建一个node服务

const Koa = require('koa');
const app = new Koa();
app.listen(3000)

2.注册路由 我们使用koa-router来实现后台服务的路由功能,并通过koa提供的上下文ctx将读取到的数据返回给前端:

const Koa = require('koa');
const Router = require('koa-router');
 
const app = new Koa();
const router = new Router({prefix: '/api'});

router.get('/name', (ctx, next) => {
    ctx.body = {
        name: 'xuxiaoxi'
    }
  });

app
  .use(router.routes())
  .use(router.allowedMethods());
  
app.listen(3000)

这样我们就能实现一个勉强能用的基本的后台api服务器了,当我们请求/api/name时,会返回相应的数据给前台,这一步是我们实现mock服务的关键一步,接下来我们具体来实现目录的遍历和api的自动注册。

3.自动注册api接口并返回数据 我们将在这个阶段实现api服务的自动注册,这里我们使用glob这个第三方模块来遍历目录,并通过node的fs模块读取api文件的数据并返回给前台。glob的使用很简单,感兴趣的朋友可以自行学习,这里就不做过多介绍了。具体实现如下:

const Koa = require('koa');
const Router = require('koa-router');
const glob = require("glob");
const { resolve } = require('path');
const fs = require('fs');
 
const app = new Koa();
const router = new Router({prefix: '/api'});

// 注册路由
glob.sync(resolve('./api', "**/*.json")).forEach((item, i) => {
    let apiJsonPath = item && item.split('/api')[1];
    let apiPath = apiJsonPath.replace('.json', '');
    
    router.get(apiPath, (ctx, next) => {
        try {
            let jsonStr = fs.readFileSync(item).toString();
            ctx.body = {
                data: JSON.parse(jsonStr),
                state: 200,
                type: 'success' // 自定义响应体
            }
        }catch(err) {
            ctx.throw('服务器错误', 500);
        }
      });
});
 
app
  .use(router.routes())
  .use(router.allowedMethods());

app.listen(3000);
  1. 添加控制台日志 我们使用koa-logger实现在终端打印node日志,方便调试,虽然这不是该文章的重点,但是对于想做node开发的前端从业者,还是很有必要了解的。
const logger = require('koa-logger')
app.use(logger());

这样,我们每个请求都会在终端打印出来。

  1. 路由映射文件的生成 该功能也不是本文的重点,但是会极大的方便前端开发者调试请求,因为如果api路径很长,我们需要一个个查找,但是有了这个map文件,我们只需要拷贝自动生成的路径即可。具体实现如下:
//...
const routerMap = {};  // 存放路由映射

// 注册路由
glob.sync(resolve('./api', "**/*.json")).forEach((item, i) => {
    // ...
    
    // 记录路由
    routerMap[apiJsonPath] = apiPath;
});

fs.writeFile('./routerMap.json', JSON.stringify(routerMap, null , 4), err => {
    if(!err) {
        console.log('路由地图生成成功!')
    }
});

基本目录结构

完整代码

clone地址 github地址

https://github.com/MrXujiang/openCoder/tree/master/mockServer

欢迎大家相互学习交流,一起探索前端的边界。

本文分享自微信公众号 - 趣谈前端(beautifulFront),作者:徐小夕

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-09-07

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 如何用不到200行代码写一款属于自己的js框架

    JavaScript 的核心是支持面向对象的,同时它也提供了强大灵活的 OOP 语言能力。本文将使用面向对象的方式,来教大家用原生js写出一个类似jQuery这...

    徐小夕
  • js基本搜索算法实现与170万条数据下的性能测试

    今天让我们来继续聊一聊js算法,通过接下来的讲解,我们可以了解到搜索算法的基本实现以及各种实现方法的性能,进而发现for循环,forEach,While的性能差...

    徐小夕
  • 基于Apify+node+react/vue搭建一个有点意思的爬虫平台

    熟悉我的朋友可能会知道,我一向是不写热点的。为什么不写呢?是因为我不关注热点吗?其实也不是。有些事件我还是很关注的,也确实有不少想法和观点。但我一直奉行一个原则...

    徐小夕
  • NB-IoT SIM7000C调试笔记 01 NB-IoT及GPRS加网测试

    NB-IoT现在有华为和高通两种最主流的方案,两个方案的代表分别是移远和SIMCOM。

    twowinter
  • Adobe发布研究报告——AR/VR的讨论量在18个月内暴增548%

    VRPinea
  • Log4j_学习_03_自己动手封装log工具

    shirayner
  • 银联高校极客挑战赛-复赛-D-多项式

    $f[u][j]$表示以$u$为根的子树中$u$到所有$v$(子树中的节点)的路径和的$j$次方的和。 可以得到一个动态转移方程: 考虑二项式展开: $(a+b...

    xiaohejun
  • 微信网页登录逻辑与实现

    现在的网站开发,都绕不开微信登录(毕竟微信已经成为国民工具)。虽然文档已经写得很详细,但是对于没有经验的开发者还是容易踩坑。

    心谭博客
  • 一个支持多协议、多源和混合p2p-cdn下载器

    PearDownloader(梨享下载器) 是PearPlayer的底层下载模块, 实现了融合HTTP(包含HTTPS、HTTP2)、WebRTC的多协议、多源...

    程序源代码
  • 使用 Python 一键下载B站视频

    但是 B 站好像没有直接提供视频下载的功能,下面给大家介绍一个非常简单强大的视频下载工具,只要电脑安装 Python 即可,而且不用动手写代码!

    Python编程与实战

扫码关注云+社区

领取腾讯云代金券