json-server使用-杨标的博客

json-server搭建模块开发环境

son-server是一款json数据服务器，可以对json文件、js脚本生成的json数据、远程json数据进行RESTFUL风格的增删改查操作，可以通过参数、分页、排序、全文搜索、关联查询、范围查询等进行复杂查询，对开发者特别是前端开发者是一款非常好用的开发工具。

官网：
https://www.npmjs.com/package/json-server

![只要一个json文件3分钟搭建一个json服务器]![只要一个json文件3分钟搭建一个json服务器]

下面我们来介绍具体的用法，

首先确保你本地安装了node.js。

一、安装json-server

$ npm install -g json-server

二、创建json文件

首先我们先创建一个db.json的文件，如下

{
  "posts": [
    { "id": 1, "title": "测试标题1", "author": "张三" },
    { "id": 2, "title": "测试标题2", "author": "李四" }
  ],
  "comments": [
    { "id": 1, "body": "这里是内容体1", "postId": 1 },
    { "id": 2, "body": "这里是内容体2", "postId": 2 }
  ],
  "profile": { "name": "测试json" }
}

三、指定json文件运行服务

$ json-server --watch db.json

![只要一个json文件3分钟搭建一个json服务器]

服务器就这么搭建好了，就是这么的快，可能还不要3分钟。

四、使用方法

请求方式遵循restful风格，

GET-查询、
POST-新增、
PUT-修改、
PATCH-修改属性、
DELETE-删除

1. GET请求-查询

可以看到资源路径都列在控制台里了，浏览网址
http://localhost:3000/posts ，出现以下结果，posts路径就是json文件里的key

[
  {
    "id": 1,
    "title": "测试标题1",
    "author": "张三"
  },
  {
    "id": 2,
    "title": "测试标题2",
    "author": "李四"
  }
]

2.POST请求-新增

使用POST请求会添加一条新记录，如POST请求：
http://localhost:3000/posts，返回新记录的id。

{
    "id": 3
}

json文件也被更改

{
  "posts": [
    {
      "id": 1,
      "title": "测试标题1",
      "author": "张三"
    },
    {
      "id": 2,
      "title": "测试标题2",
      "author": "李四"
    },
    {
      "id": 3
    }
  ],
  "comments": [
    {
      "id": 1,
      "body": "这里是内容体1",
      "postId": 1
    },
    {
      "id": 2,
      "body": "这里是内容体2",
      "postId": 2
    }
  ],
  "profile": {
    "name": "测试json"
  }
}

3.PUT请求-修改

PUT请求会修改一条记录，如请求：
http://localhost:3000/posts/3，我们在请求body里输入以下修改内容：

{
    "title":"这是修改的内容",
    "author":"王五"
}

json文件变成了

{
  "posts": [
    {
      "id": 1,
      "title": "测试标题1",
      "author": "张三"
    },
    {
      "id": 2,
      "title": "测试标题2",
      "author": "李四"
    },
    {
      "title": "这是修改的内容",
      "author": "王五",
      "id": 3
    }
  ],
  "comments": [
    {
      "id": 1,
      "body": "这里是内容体1",
      "postId": 1
    },
    {
      "id": 2,
      "body": "这里是内容体2",
      "postId": 2
    }
  ],
  "profile": {
    "name": "测试json"
  }
}

4.PATCH请求-修改单个属性

PATCH与PUT的区别在于，PUT的请求内容需要包含整个对象除id外的所有属性，PATCH的请求内容可以是单个属性。

比如我们PATCH请求：
http://localhost:3000/posts/3 ，body为

{
    "title":"这是修改的内容xxxx"
}

json文件里id为3的记录仅title属性发生改变，其他字段不变

{
  "posts": [
    {
      "id": 1,
      "title": "测试标题1",
      "author": "张三"
    },
    {
      "id": 2,
      "title": "测试标题2",
      "author": "李四"
    },
    {
      "title": "这是修改的内容xxxx",
      "author": "王五",
      "id": 3
    }
  ],
  "comments": [
    {
      "id": 1,
      "body": "这里是内容体1",
      "postId": 1
    },
    {
      "id": 2,
      "body": "这里是内容体2",
      "postId": 2
    }
  ],
  "profile": {
    "name": "测试json"
  }
}

5.DELETE请求-删除

DELETE请求会删除一条数据，如请求：
http://localhost:3000/posts/3 。

删除后的json文件内容发生改变，可以看到id为3的记录没了：

{
  "posts": [
    {
      "id": 1,
      "title": "测试标题1",
      "author": "张三"
    },
    {
      "id": 2,
      "title": "测试标题2",
      "author": "李四"
    }
  ],
  "comments": [
    {
      "id": 1,
      "body": "这里是内容体1",
      "postId": 1
    },
    {
      "id": 2,
      "body": "这里是内容体2",
      "postId": 2
    }
  ],
  "profile": {
    "name": "测试json"
  }
}

6.过滤id

浏览
http://localhost:3000/posts/1 ，代表读取post里id为1的那条数据，注意不是代表第1条，而是id为1的那条。

{
  "id": 1,
  "title": "测试标题1",
  "author": "张三"
}

7.过滤参数

浏览
http://localhost:3000/posts?author=张三

[
  {
    "id": 1,
    "title": "测试标题1",
    "author": "张三"
  }
]

如果有多级也可以用“.”+属性名查询如
http://localhost:3000/posts?author.name=张三。

8.排序

通过“_sort”指定排序属性和“_order”指定asc顺序还是desc倒序查询，如：
http://localhost:3000/posts?_sort=id&_order=desc 。

9.分页

通过“_page”和“_limit”进行分页查询，如查询第一页，每页20条查询写法：
http://localhost:3000/posts?_page=1&_limit=20

10.截取部分

通过“_start”、“_end”和“_limit”参数查询，如从20条开始查询10条数据：
http://localhost:3000/posts/1/comments?_start=20&_limit=10

11.不等于查询

通过“属性名_ne”写法如：
http://localhost:3000/posts?id_ne=1

[
  {
    "id": 2,
    "title": "测试标题2",
    "author": "李四"
  }
]

12.大于等于/小于等于查询

通过“属性名_gte”查询大于等于，通过“属性名_lte”查询小于等于，写法如：
http://localhost:3000/posts?views_gte=10&views_lte=20

[]

13.like查询

通过“属性名_like”的写法查询如
http://localhost:3000/posts?title_like=标题1

[
  {
    "id": 1,
    "title": "测试标题1",
    "author": "张三"
  }
]

14.全文搜索

通过q查询参数如：
http://localhost:3000/posts?q=标题

[
  {
    "id": 1,
    "title": "测试标题1",
    "author": "张三"
  },
  {
    "id": 2,
    "title": "测试标题2",
    "author": "李四"
  }
]

15.关联查询

通过_embed参数请求如：
http://localhost:3000/posts?_embed=comments ，代表posts关联comments。

[
  {
    "id": 1,
    "title": "测试标题1",
    "author": "张三",
    "comments": [
      {
        "id": 1,
        "body": "这里是内容体1",
        "postId": 1
      }
    ]
  },
  {
    "id": 2,
    "title": "测试标题2",
    "author": "李四",
    "comments": [
      {
        "id": 2,
        "body": "这里是内容体2",
        "postId": 2
      }
    ]
  }
]

五、指定端口

命令增加 --port参数

$ json-server --watch db.json --port 3004

六、使用js脚本生成数据代替json

创建一个index.js文件用于生成数据

module.exports = () => {
  const data = { users: [] }
  // Create 1000 users
  for (let i = 0; i < 1000; i++) {
    data.users.push({ id: i, name: `user${i}` })
  }
  return data
}

运行服务指定js文件

$ json-server index.js

1.使用远程地址加载数据

$ json-server http://example.com/file.json
$ json-server http://jsonplaceholder.typicode.com/db

2.作为静态文件服务器

创建一个public目录，创建一个内容为hello world的index.html文件。

$ mkdir public
$ echo 'hello world' > public/index.html
$ json-server db.json

访问 http://localhost:3000/ ，根路径会默认显示public目录下的内容，会显示index.html的内容。

'hello world'

也可以通过--static参数指定其他路径的目录

$ json-server db.json --static ./some-other-dir

3. 自定义请求路由

创建一个 routes.json文件用于定义请求路由，每个路径都由 / 开头。

{
  "/api/*": "/$1",
  "/:resource/:id/show": "/:resource/:id",
  "/posts/:category": "/posts?category=:category",
  "/articles\\?id=:id": "/posts/:id"
}

启动服务时指定请求路由定义文件

json-server db.json --routes routes.json

以下访问左边的路径分别对应右边的原始请求效果

/api/posts ==》 /posts
/api/posts/1 ==》 /posts/1
/posts/1/show ==》 /posts/1
/posts/javascript ==》 /posts?category=javascript
/articles?id=1 ==》 /posts/1

七、json-server启动的配置文件

我们之前使用 json-server --watch db.json 这条命令启动了接口项目，其中 json-server 是服务启动的命令，--watch 是参数，db.json 是目标文件。

使用下面这条命令可以查看配置项：

参数	简写	说明
–config	-c	指定配置文件
–port	-p	端口号
–host	-H	主机地址
–watch	-w	监听文件
–routes	-r	指定路由文件
–middlewares	-m	指定中间件
–static	-s	设置静态文件
–read-only	–ro	只读
–no-cors	–nc	禁用跨源资源共享
–no-gzip	–ng	禁止GZIP
–snapshots	-S	设置快照目录
–delay	-d	设置反馈延时（ms）
–id	-i	设置数据的id属性（e.g. _id）
–foreignKeySuffix	–fks	设置外键后缀（如post_id中的_id）
–quiet	-q	禁止输出日志消息
–help	-h	显示帮助信息
–version	-v	显示版本号

目录CONTENT

json-server使用