快速提示：使用JSON服务器模拟REST API

无需后端即可快速原型设计前端应用？创建即使是最基本的模拟API也可能耗时费力。json-server库通过提供一种快速简便的方法来创建用于开发和测试的复杂RESTful API，从而解决了这个问题。

本快速提示将教您如何使用json-server创建模拟REST API，让您在短短30秒内即可启动并运行功能齐全的API。

关键要点

• json-server库可用于快速创建用于开发和测试的复杂RESTful API，允许开发人员在没有后端的情况下原型设计应用程序的前端。
• json-server提供过滤器、逻辑运算符、分页和排序等功能，有助于创建可用于测试具有大量伪造数据的前端的模拟API。
• 通过faker.js模块，开发人员可以为API生成模拟数据，这使得开发和测试过程更高效、更贴近实际情况。

前提条件

您应该具备RESTful原则以及如何使用API的基本知识。

您需要以下工具：

• nodejs – json-server基于nodejs构建。
• curl – 用于测试模拟服务器的路由。

Windows用户：curl下载页面提供了32位和64位版本的curl二进制文件，您可以使用它们来学习本文中的示例。

本教程假设您将使用类似bash的终端。

安装

要安装json-server，请打开您的终端并输入：

$ npm install -g json-server

这将在您的系统上全局安装json-server，以便您可以从任何喜欢的目录启动服务器。

资源

在RESTful API中，资源是一个具有类型、关联数据、与其他资源的关系以及对其进行操作的一组方法的对象。例如，如果您正在为电影创建API，那么电影就是一个资源。您可以使用您的API对该资源应用CRUD操作。

让我们创建一个具有/movies资源的API。

创建资源

创建一个名为db.json的文件，并将以下内容添加到其中：

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

保存文件后，使用以下命令启动服务器：

$ json-server --watch db.json

就是这样！现在您拥有了一个电影API；您可以从此服务器获取电影、添加新电影、删除电影以及许多其他操作。

为了测试我们的模拟API，我们可以使用curl发出HTTP请求：

$ curl -X GET "http://localhost:3000/movies"

这将返回您在此服务器上拥有的所有电影的列表。在上述情况下，您将获得两部电影。现在要获取id为1的电影，只需在URI的末尾指定id：http://localhost:3000/movies/1。

要向服务器添加电影，您可以向API发送包含电影详细信息的POST请求。例如：

$ npm install -g json-server

这将返回新的电影数据。要检查记录是否已成功添加，让我们尝试获取id为3的电影：

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

同样，您可以使用其他HTTP动词（如PUT和DELETE）来访问和修改此服务器上的数据。按照惯例，POST用于创建新实体，而PUT用于更新现有实体。

注意：PUT、POST和PATCH请求需要设置Content-Type: application/json标头。

功能

json-server为模拟API提供了许多有用的功能，这些功能您需要在后端手动构建。让我们探索其中一些功能：

过滤器

您可以通过将过滤器附加到URI作为查询字符串来应用过滤器。例如，如果您想获取名为“Casablanca”的电影的详细信息，您可以向资源URI发送GET请求，附加一个问号（?），然后是您要过滤的属性名称及其值：

$ json-server --watch db.json

您还可以通过在不同的过滤器之间添加一个与号（&）来组合多个过滤器。例如，如果我们还想在上面的例子中按id进行过滤，我们可以使用：

$ curl -X GET "http://localhost:3000/movies"

运算符

API还为您提供了逻辑运算符，使过滤更容易。您可以使用_gte和_lte作为大于和小于运算符。您还有_ne用于从响应中排除值。

例如，如果您想要所有评分大于或等于9的电影：

$ curl -X POST -H "Content-Type: application/json" -d '{
  "id": 3,
  "name": "Inception",
  "director": "Christopher Nolan",
  "rating": 9.0
}' "http://localhost:3000/movies"

请注意，您可以使用与号组合多个运算符。因此，要获取所有评分在5到7之间的电影，您将发出以下请求：

$ curl -X GET "http://localhost:3000/movies/3"

分页

在现实世界中，您将处理大量数据。使用json-server内置的分页支持（每页固定10个项目）可以轻松地将这些数据加载到小块中。

例如，如果您想访问电影API的第3页，请发送GET请求：

$ curl -X GET "http://localhost:3000/movies?name=Casablanca"

这将返回第21-30个项目。

排序

您可以使用_sort和_order属性从API请求排序后的数据。例如，如果您希望电影列表按名称（按字母顺序）以降序排序，那么您将发送以下请求：

$ curl -X GET "http://localhost:3000/movies?name=Casablanca&id=2"

json-server提供了许多其他功能。您可以在json-server文档中详细了解这些功能和上述功能。

为您的API生成模拟数据

使用API中几乎没有数据来测试前端是没有乐趣的。您可以使用像faker.js这样的模块为您的模拟API创建一些示例数据。

使用以下命令安装软件包：

$ curl -X GET "http://localhost:3000/movies?rating_gte=9"

现在创建一个名为fake-data-generator.js的文件，并在其中输入以下内容：

$ curl -X GET "http://localhost:3000/movies?rating_gte=5&rating_lte=7"

在这里，我们创建了1000个不同的假电影条目，使用faker生成电影标题和导演姓名。评分是通过生成1到100之间的随机数并除以10来创建的。

要使用此脚本创建db.json文件，请在终端中运行以下命令：

$ npm install -g json-server

现在您拥有一个包含1000部电影的数据库。您现在拥有大量可以用来开发和/或测试您的应用程序的伪造数据。

结论

您现在应该能够快速创建您自己的模拟API并向其中添加测试数据。json-server库允许您快速原型设计前端代码，而无需花费任何时间（几乎）来创建前端。

这个工具会成为您工作流程的一部分吗？或者您还有其他成功使用的方法吗？请在下面的评论中分享您的想法和建议！

关于使用JSON Server模拟REST API的常见问题解答（FAQ）

使用JSON Server模拟REST API的主要优势是什么？

JSON Server提供了一种简单快捷的方法来为开发和测试目的设置伪造的REST API。它允许开发人员在几分钟内创建一个具有CRUD（创建、读取、更新、删除）操作的完整REST API。这可以大大加快开发过程，因为它消除了等待后端团队开发实际API的需要。此外，JSON Server使用JSON文件存储数据，从而易于修改API的数据和结构。

如何安装JSON Server？

JSON Server是一个Node.js模块，因此您需要在系统上安装Node.js和npm（Node Package Manager）。安装Node.js和npm后，您可以使用终端或命令提示符中的以下命令在系统上全局安装JSON Server：npm install -g json-server。

如何使用JSON Server创建模拟API？

要使用JSON Server创建模拟API，您首先需要创建一个JSON文件，该文件将充当您的数据库。此文件应包含您希望通过API提供的数

(由于篇幅限制，后续FAQ内容将被省略。 如有需要，请提出具体问题。)

以上是快速提示：使用JSON服务器模拟REST API的详细内容。更多信息请关注PHP中文网其他相关文章！