简介
json-server
是一款小巧的接口模拟工具,一分钟内就能搭建一套 Restful 风格的 API,尤其适合前端接口测试使用。
只需指定一个 json
文件作为 api
的数据源即可,使用起来非常方便,30秒入门,基本上有手就行。
进阶操作还支持分页,排序等操作,简直强大。
开源地址
主页地址:json-server - npm
Github项目地址:GitHub - typicode/json-server: Get a full fake REST API with zero coding in less than 30 seconds (seriously)
30秒入门
环境依赖
- 安装 Node.js 环境即可
操作步骤
- 安装 JSON 服务器
npm install -g json-server
- 创建一个
db.json
包含一些数据的文件
{
"posts": [
{ "id": 1, "title": "json-server", "author": "typicode" }
],
"comments": [
{ "id": 1, "body": "some comment", "postId": 1 }
],
"profile": { "name": "typicode" }
}
- 启动
json-server
接口服务器
json-server --watch db.json
- 浏览器访问 http://localhost:3000/posts/1,你会得到
{ "id": 1, "title": "json-server", "author": "typicode" }
补充
- 如果您发出 POST、PUT、PATCH 或 DELETE 请求,更改将自动安全地保存到
db.json
文件中。 - 注意 id 值是不可变的。
路由进阶
根据之前的db.json
文件,这里是所有的默认路由。
路由形式一
GET /posts
GET /posts/1
POST /posts
PUT /posts/1
PATCH /posts/1
DELETE /posts/1
路由形式二
GET /profile
POST /profile
PUT /profile
PATCH /profile
筛选
使用 .
访问筛选
GET /posts?title=json-server&author=typicode
GET /posts?id=1&id=2
GET /comments?author.name=typicode
分页
使用_page
和可选地_limit
对返回的数据进行分页。
在Link
标题,你会得到first
,prev