使用json-server搭建模拟api接口
做前后分离的项目时。有时候前端的页面写完了,后端还没写好API接口。这时,我们可以使用json-server快速搭建一个测试的api接口。
GitHub上有详细的官方使用手册,GitHub地址:https://github.com/typicode/json-server
1、电脑需要安装Node.js
进入https://nodejs.org/en/,下载对应的版本安装。(Node.js安装教程+npm配置)
2、使用npm安装全局的json-server。运行命令:npm install -g json-server
打开cmd,然后运行命令 npm install -g json-server (cmd启动的几种方式)
在npm全局的文件夹中可以看到刚刚安装完成的插件
3、创建一个文件夹(文件名随便取。我的是在D盘创建了一个my-json-server的文件夹)
4、在这个文件夹目录下打开cmd,运行命令 npm init --yes
运行完之后就能看到一个package.json的文件
5、在刚刚的文件夹(my-json-server)下运行命令 npm install json-server --save 安装依赖模块
安装完成之后多了两个东西
6、在文件夹(my-json-server)下编写一个json的数据文件(这个文件的数据就是你需要通过接口获取的数据。文件的名字随便起。我起的是my-json-data.json)
我的数据:
{ "users": [ { "name": "tt", "phone": "123456789", "email": "111@qq.com", "age": "20", "id": 1, "companyId": 1 } ], "companies": [ { "id": 1, "name": "Apple", "description": "Apple lalala!" } ] }
简单说一下:users是一个接口、companies是另一个接口。也就是说这个文件是可以配置多个不同的接口的。后面运行的时候会说到。
注意:文件的json格式一定要正确,不然会运行不起来。这里推荐一个json的格式化在线网站:https://www.json.cn/
7、修改配置文件,在package.json文件中添加 "json:server": "json-server --watch db.json" 这一句。
8、在文件夹(my-json-server)下运行命令 npm run json:server
9、这样一个API接口就做好了。随便找一个接口看看效果
数据一模一样,完成!!!