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

最新推荐文章于 2024-07-27 17:45:32 发布

dideng9048

最新推荐文章于 2024-07-27 17:45:32 发布

阅读量100

点赞数

文章标签： json 后端 postman

原文链接：http://www.cnblogs.com/kevoin/p/10124346.html

版权

在本教程中，您会看到如何通过 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 请求，你会发现这个用户已经不在返回的数据当中了。