使用 json-server 来建立一个模拟 API

在本教程中，您会看到如何经过 json-server 来设置和使用模拟的 REST API，并可使用它来完成移动应用或 Web 应用程序的开发

 

什么是 REST？

REST 是 Representational State Transfer（具象状态传输） 的缩写。它是一种用于传递信息的架构风格。它使经过简单的 HTTP 来在不一样的软件或程序中互相专递信息变成可能。 咱们针对一个 URL 经过不一样类型的 HTTP 请求来对对应的用户信息（资源）进行对应的请求（例如 GET 为获取，POST 为建立，DELETE 为删除，等），而不是使用不一样的 URL 对资源进行直接的请求。

举个例子，若是须要删除一个用户。咱们须要作的仅仅是对 /user/10 发出一个 `DELETE` 的请求，而不是对 /deleteuser?id=10 发出一个 GET 请求。 （这样的操做更简洁也更有意义）

为何咱们须要一个模拟 API？

REST API 提供了移动应用以及 Web 应用的后端支持。有些时候当你在进行开发时，你须要的后端接口可能尚未完成对于开发所须要的支持。 咱们须要一个模拟 API 提供一些伪造数据来模拟真实环境下的移动应用和 Web 应用的使用场景。

这就是咱们为何须要模拟 REST API 的缘由，然而 json-server 能够很轻易的知足咱们的这些需求。

让咱们开始吧

在咱们开始以前咱们须要经过 Node 来安装 json-server。

npm install -g json-server

 接下来咱们须要建立一个 JSON 文件，它包含着咱们开发所须要的伪造数据。好比我须要一些 JSON 数据，其中包含了了一些基础的用户信息例如 ID，姓名，地址等等。咱们将新建一个包含这些信息的文件并将其命名为 info.json。

 

{
    "users": [{
        "id": 1,
        "name": "kobe",
        "location": "los"
    }, {
        "id": 2,
        "name": "james",
        "location": "los"
    }]
}

 下面的命令在终端运行 json-server 并将 info.json 设置为数据源，这时模拟 API 应该已经容许在 http://localhost:3000 端口。

json-server info.json

 

测试 REST API 终端

咱们的虚拟 API 已经可使用，接下来让咱们来看看如何在一个客户端中使用这个 REST API。在下面的例子中我将使用 Postman REST Client （一款 Chrome App） 来发起 API 请求。

GET 请求

咱们首先对 REST API 发起一个 GET 请求。在数据源文件（JSON 文件）中定义了一个 users 的终端，其中包好了用户相关的信息。 对 http://localhost:3000/users 发起 GET 请求会显示如今已经存在的信息。

 

 

POST 请求

咱们能够经过向  http://localhost:3000/users 发起 POST 请求来添加心的数据到已有的数据源中。下面是一个 POST 请求的实例：

 

 

再作一次 GET 请求你会发现咱们刚刚新建的数据已经存在于 info.json 文件中了。

 

DELETE 请求

你只须要对 API 终端发起一个包好用户 ID 的 DELETE 请求就能够从 json-server 的数据中删除对应用户的条目。 好比，若是你想删除用户 ID 为 1 的用户，你只须要对 http://localhost:3000/users/1 发起一个 DELETE 的 请求便可。但你完成删除后，再发起一个 GET 请求，你会发现这个用户已经不在返回的数据当中了。

 

PATCH 请求

你能够经过 PATCH 请求来更新一个条目，咱们须要在请求中包含须要更新条目的全部信息。好比，若是你想更新一个用户 ID 为 2 的用户，你须要对 http://localhost:3000/users/2 发出下面同样 PATCH 请求：

 

 

搜索 json-server 可用的 REST API

使用 json-server REST API，你能够基于某些条件搜索要查找数据的数据。例如，要查找具备某个特定名称的用户，你须要对 REST API URL 发起一个像下面同样的 GET 请求︰

 

 

如上图所示，对 http://localhost:3000/users?name=james 发起一个 GET 请求将会返回全部用户名为 james 的用户数据。同理你也能够搜索其余的数据键。

对 REST API 终端进行全文搜索你须要在搜索字符串添加参数 q。例如，若是你要锁搜用户信息中包含 s的用户，你的请求会像下面同样。

 

 

处理分页

在显示分页的数据时，你须要能够基于分页需获取一些数据。在这种状况下，json-server 提供的了 JSON 数据的分页功能。 默认状况下，计数从 json-server 返回的数据条目数是 10。咱们能够设定此限制使用 _limit 参数。

http://localhost:3000/users?_limit=5

对上面的 URL 的 GET 请求会返回五条记录。如今要对数据进行分页，咱们须要添加另外一个参数 _page 到 URL 中。_page 定义了页面所须要获取返回的数据页数。

http://localhost:3000/users?_limit=5&_page=2

对上面的 URL 发起 GET 请求会返回全部数据分页后第二页中的五条记录。经过改变 _page 变量，咱们能够获取所需的页记录。

处理排序

json-server 提供了将检索的数据进行排序的功能。咱们能够经过提供须要排序的列名称和须要排序的顺序对数据进行排序。 在默认状况下，数据按升序排序。咱们能够在 URL 终端中使用关键字 _sort 和定义使用关键字 _order 来调整顺序。下面是一个示例 URL:

http://localhost:3000/users?_sort=id&_order=DESC

上面的 URL 将基于 ID，对数据进行排序并它将按降序排列。

 

 

处理操做符

json-server 还提供了实用运算符找到 ID 匹配特定的正则表达式的条目或寻找两个值范围内条目的功能。

为了寻找一个特定范围内的条目，咱们可以使用的 _gte 和 _lte 的操做符。例如，若要查找用户 ID 大于 1 且小于 2，发起一个 GET 请求 http://localhost:3000/users?id_gte=1&id_lte=2，如图所示︰

 

若是咱们想要搜索某个特定字母开头的名字，咱们可使用正则表达式。例如，要搜索的名字开头字母 james，咱们可使用运算符 _like 使用并发起像下面同样的 GET 请求 http://localhost:3000/users?name_like=^james

 

 参考资料

https://code.tutsplus.com/tutorials/fake-rest-api-up-and-running-using-json-server--cms-27871?ec_unit=translation-info-language