JSON Server 是一个用于快速创建模拟 REST API 的工具,主要用在前端开发和原型设计中。
主要特点
零编码:只需一个 JSON 文件即可创建完整的 API
RESTful:自动提供完整的 REST API 端点
真实 HTTP:使用真实的 HTTP 请求(GET、POST、PUT、DELETE 等)
安装和使用
bash
安装
npm install -g json-server
创建 db.json 文件
{
"posts": [
{ "id": 1, "title": "Hello World", "author": "John" },
{ "id": 2, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 3, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 4, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 5, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 6, "title": "Hello World", "author": "John" },
{ "id": 7, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 8, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 9, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 10, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 11, "title": "Hello World", "author": "John" },
{ "id": 12, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 13, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 14, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 15, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 16, "title": "Hello World", "author": "John" },
{ "id": 17, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 18, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 19, "title": "Hello wang", "author": "XiaoWang" },
{ "id": 20, "title": "Hello wang", "author": "XiaoWang" }
],
"comments": [
{ "id": 1, "body": "Great post", "postId": 1 }
],
"profile": {
"name": "Jane Doe"
}
}
启动服务器
json-server --watch db.json --port 3000
自动生成的 API 端点
text
GET /posts
GET /posts/1
POST /posts
PUT /posts/1
PATCH /posts/1
DELETE /posts/1
GET /posts/1/comments # 关联数据
高级功能
过滤:/posts?title=json-server&author=typicode
分页:/posts?_page=1&_limit=10
排序:/posts?_sort=views&_order=asc
全文搜索:/posts?q=hello
关系:/posts/1/comments
使用场景
前端开发:在后端 API 完成前进行前端开发
原型设计:快速验证产品概念
测试:为自动化测试提供模拟数据
教学演示:REST API 教学示例
你想了解 JSON Server 的哪个特定方面呢?