什么是 node-echo-server?
node-echo-server 是一个基于 Node.js 的轻量级 HTTP 服务器,用于在本地运行并测试前端代码。通过配置,它可以返回与请求匹配的响应,模拟 API 接口,以及管理 HTTPS/TLS 等更高级的选项。
安装和使用
安装 node-echo-server
npm install -g node-echo-server
启动 server
node-echo-server
访问 server
在浏览器中输入
http://localhost:3000
,即可访问 server。配置 server(可选)
可以在项目根目录下创建
echo.config.js
文件,用于配置 server 相关的选项。-- -------------------- ---- ------- -------------- - - ----- ----- ------ ------ ----- --------- ------------- -- -------- ------ ------ - ------------- -------------------- ------------- ----- ---- -- - ---------- -------- ----- -------- ------ --- -- ---------------- ----- ---- ------ -- - ----- - -- - - ------ ----- ---- - - --- ------ -------- ------ -- --------------- -- -- ---- - ---- ------------ ----- ------------- -- --
上面的配置项及其含义如下:
port
:server 监听的端口号,默认为3000
。quiet
:是否关闭 server 的日志输出,默认为false
。path
:mock 数据所在的目录,默认为'./mock'
。responseTime
:模拟请求的响应时间,单位为毫秒,默认为0
。timeout
:请求的超时时间,单位为毫秒,默认为10000
。mocks
:模拟 API 接口,该对象的键为 URL,值为响应数据或回调函数。tls
:HTTPS/TLS 相关的选项。如果该对象存在,则 server 会以 HTTPS/TLS 方式运行。
示例代码
读取 mock 数据
在项目根目录下创建
mock/users.json
文件。{ "success": true, "data": { "name": "Alice", "age": 18 } }
启动 server 后,在浏览器中输入
http://localhost:3000/api/users
,即可查看该数据。模拟请求的响应时间
修改
echo.config.js
文件,设置responseTime: 5000
。重新启动 server 后,在浏览器中输入http://localhost:3000
,等待 5 秒钟后,即可看到页面显示出来。模拟 API 接口
修改
echo.config.js
文件,添加以下配置:mocks: { '/api/login': (req, res) => { res.json({ success: true, message: '登录成功' }); } }
在浏览器中输入
http://localhost:3000/api/login
,即可看到返回的 JSON 数据。使用回调函数动态生成响应数据
修改
echo.config.js
文件,添加以下配置:mocks: { '/api/articles': (req, res, query) => { const { id } = query; const data = { id, title: 'Article Title' }; res.json(data); } }
在浏览器中输入
http://localhost:3000/api/articles?id=123
,即可看到返回的 JSON 数据。
总结
node-echo-server 是一个非常实用的本地开发工具,可以模拟 API 接口,管理多个项目的 mock 数据,以及支持 HTTPS/TLS 等高级选项。通过学习本文,你可以了解到如何安装和配置 node-echo-server,以及如何在实际项目中使用它。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055fcf81e8991b448dd573