使用Express模拟接口数据

客官°小女子只卖身不卖艺 2021-11-04 15:14 485阅读 0赞

Express简介

Express是一个基于 Node.js 平台,快速、开放、极简的 Web 开发框架。Express 在 node.js 基础上扩展了 Web 应用所需的功能,并提供了丰富的 HTTP 实用工具以及来自Connect框架的中间件,使得创建强健、友好的 API 变得快速而且简单。

NodeJS下安装Express

  1. npm install express -g // 全局安装
  2. npm install express --save // 项目本地安装

模拟接口数据

创建本地应用

打开命令行窗口,切换到要创建应用的目录下,执行如下命令完成项目创建。

  1. // 创建项目目录
  2. mkdir api-server
  3. // 进入项目目录
  4. cd api-server
  5. // 生成项目的 package.json 文件,此命令需要输入几个参数,参见下图
  6. npm init
  7. // 引入依赖
  8. npm install express --save

2019080808375579.gif

如图所示,本例中项目的入口文件名称被指定为 server.js (默认为 index.js),在项目根目录下创建 server.js ,内容如下:

  1. const express = require('express');
  2. const app = express();
  3. // 模拟字符串数据
  4. app.get('/user/18818578458', (req, res) => res.send('{id:"18818578458",name:"pengjunlee"}'));
  5. // 模拟HTML数据
  6. app.get('/index', function getHome(req,res,next){
  7. res.setHeader('Content-Type', 'text/html');
  8. res.sendfile(`${__dirname}/index.html`);
  9. })
  10. app.listen(3000, () => console.log('Example app listening on port 3000!'));

然后,执行如下命令启动项目并监听 3000 端口:

  1. node server.js

访问 http://localhost:3000/user/18818578458 ,返回如下内容:

2019080809082047.png

使用Express-Generator创建应用

通过应用生成器工具 express-generator 可以快速创建一个应用的骨架。express-generator 包含了 express 命令行工具。通过如下命令即可安装:

  1. npm install express-generator -g

-h 参数可以列出所有可用的命令行参数:

  1. > express -h
  2. Usage: express [options] [dir]
  3. Options:
  4. -h, --help // 输出使用方法
  5. --version // 输出版本号
  6. -e, --ejs // 添加对 ejs 模板引擎的支持
  7. --hbs // 添加对 handlebars 模板引擎的支持
  8. --pug // 添加对 pug 模板引擎的支持
  9. -H, --hogan // 添加对 hogan.js 模板引擎的支持
  10. --no-view // 创建不带视图引擎的项目
  11. -v, --view <engine> // 添加对视图引擎(view) <engine> 的支持 (ejs|hbs|hjs|jade|pug|twig|vash) (默认是 jade 模板引擎)
  12. -c, --css <engine> // 添加样式表引擎 <engine> 的支持 (less|stylus|compass|sass) (默认是普通的 css 文件)
  13. --git // 添加 .gitignore
  14. -f, --force // 强制在非空目录下创建

例如,如下命令创建了一个名称为 mock-server 的 Express 应用。此应用将在当前目录下的 mock-server 目录中创建,并且设置为使用 Pug 模板引擎(view engine):

  1. > express --view=pug mock-server
  2. create : mock-server\
  3. create : mock-server\public\
  4. create : mock-server\public\javascripts\
  5. create : mock-server\public\images\
  6. create : mock-server\public\stylesheets\
  7. create : mock-server\public\stylesheets\style.css
  8. create : mock-server\routes\
  9. create : mock-server\routes\index.js
  10. create : mock-server\routes\users.js
  11. create : mock-server\views\
  12. create : mock-server\views\error.pug
  13. create : mock-server\views\index.pug
  14. create : mock-server\views\layout.pug
  15. create : mock-server\app.js
  16. create : mock-server\package.json
  17. create : mock-server\bin\
  18. create : mock-server\bin\www
  19. change directory:
  20. > cd mock-server
  21. install dependencies:
  22. > npm install
  23. run the app:
  24. > SET DEBUG=mock-server:* & npm start

然后,切换到项目目录,安装所有依赖包:

  1. > cd mock-server
  2. > npm install

在 MacOS 或 Linux 中,通过如下命令启动此应用:

  1. $ DEBUG=mock-server:* npm start

在 Windows 中,通过如下命令启动此应用:

  1. > set DEBUG=mock-server:* & npm start

然后在浏览器中打开 http://localhost:3000/ 网址就可以看到这个应用了。

20190808093302563.png

通过生成器创建的 mock-server 应用目录结构如下:

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BlbmdqdW5sZWU_size_16_color_FFFFFF_t_70

webpack项目中使用Express

旧版的webpack项目是在dev-server.js文件中配置的模拟数据,新版的webpack项目已经去掉了dev-server.js和dev-client.js,模拟数据改为在 webpack.dev.conf.js 中进行配置。

首先切换到项目目录,执行 npm install express —save 为项目安装 express 。然后在 webpack.dev.conf.js 的如下两处位置添加代码。

  1. /* 。。。 */
  2. const portfinder = require('portfinder')
  3. /* ====== 要插入的第一段代码开始 ====== */
  4. // 引入express
  5. const express = require("express")
  6. const bodyParser = require('body-parser');
  7. // 创建express实例
  8. const app = express()
  9. // 解析application/json
  10. var jsonParser = bodyParser.json();
  11. // 解析application/x-www-form-urlencoded
  12. // var urlencodedParser = bodyParser.urlencoded({extended: false});
  13. // 读取/mock/login.json中的json数据
  14. var loginData = require("../src/mock/login.json")
  15. /* ====== 要插入的第一段代码结束 ====== */
  16. const HOST = process.env.HOST
  17. const PORT = process.env.PORT && Number(process.env.PORT)
  18. const devWebpackConfig = merge(baseWebpackConfig, {
  19. /* 。。。 */
  20. devServer: {
  21. /* 。。。 */
  22. watchOptions: {
  23. poll: config.dev.poll,
  24. },
  25. /* ====== 要插入的第二段代码开始 ====== */
  26. before(app) { // localhost:8080/api/login
  27. app.post("/api/login",jsonParser, (req, res) => {
  28. if(!req.body) return res.sendStatus(400);
  29. res.send(loginData[req.body.name === 'admin' ? 'admin':'other']);
  30. // res.json(loginData);
  31. })
  32. }
  33. /* ====== 要插入的第二段代码结束 ====== */
  34. },
  35. /* 。。。 */
  36. })

执行 npm run dev 命令重启应用,访问 http://localhost:8080/api/login 即可获取到我们定义的Json 数据。

20190808104803626.png

使用Express托管静态文件

如果需要使用Express对外提供诸如图像、CSS 和 JavaScript 之类的静态文件,可以使用 Express 中的 express.static 内置中间件函数。例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:

  1. app.use(express.static('public'))

现在,你就可以访问 public 目录中的所有文件了。

  1. http://localhost:3000/images/logo.png

你也可以为你的资源指定一个虚拟的访问路径,例如:

  1. app.use('/static', express.static('public'))

现在,你就可以通过带有 /static 前缀地址来访问 public 目录中的文件了。

  1. http://localhost:3000/static/images/logo.png

Express 在静态资源文件夹中查找文件,因此,存放静态资源的文件夹的目录名不会出现在 URL 中。如果要使用多个静态资源目录,请多次调用 express.static 中间件函数:

  1. app.use('/public', express.static('public'))
  2. app.use('/files', express.static('files'))

访问静态资源文件时,express.static 中间件函数会根据目录的添加顺序查找所需的文件。

需要注意的是, express.static 函数的 path 参数的路径是相对于express 实例的启动目录来说的,如果你的 express 实例是从其他目录启动的,很有可能会出现传入的path路径找不到的情况,安全一点的做法就是使用绝对路径。

  1. app.use('/static', express.static(path.join(__dirname, 'public')))

发表评论

表情:
评论列表 (有 0 条评论,485人围观)

还没有评论,来说两句吧...

相关阅读

    相关 实战:Express 模拟 CSRF 攻击

    CSRF攻击 是前端领域常见的安全问题,概念方面不再赘述,可以参考维基百科。对于这些概念,包括名词定义、攻击方式、解决方案等估计大家都看过不少,但留下印象总是很模糊,要动手操作