json-server如何添加状态

json-server轻松上手：如何为你的API添加状态字段**

在快速构建和测试前端应用时,json-server 无疑是一个非常受欢迎的工具，它能让我们仅用一个 JSON 文件就能快速搭建一个功能齐全的 RESTful API，在实际应用场景中，数据往往伴随着“状态”信息，例如一个任务的状态可能是“待办”、“进行中”或已完成”，一个订单的状态可能是“待支付”、“已支付”、“已发货”或“已完成”，如何在 json-server 中为我们的资源添加状态字段呢？其实非常简单，本文将详细介绍几种常用方法。

直接在 JSON 数据文件中定义状态字段

这是最直接也是最基础的方法,如果你在创建 db.json 文件时就已经明确了哪些字段需要包含状态信息，那么直接在数据中添加即可。

示例：

假设我们有一个简单的待办事项列表 db.json：

{
  "todos": [
    {
      "id": 1,
      "title": "学习 json-server",
      "status": "pending" // 直接添加 status 字段
    },
    {
      "id": 2,
      "title": "写一篇关于 json-server 状态的文章",
      "status": "in-progress" // 直接添加 status 字段
    },
    {
      "id": 3,
      "title": "发布文章",
      "status": "completed" // 直接添加 status 字段
    }
  ]
}

操作步骤：

创建或编辑你的 db.json 文件。
在你需要添加状态的数据对象中,添加一个 status 字段（或其他你喜欢的名称，如 state, status_code 等），并赋予其初始值。
保存 db.json 文件。
启动 json-server：json-server --watch db.json

验证：

启动后,你可以通过 GET 请求 http://localhost:3000/todos 来获取所有待办事项，你会看到每个任务都包含了 status 字段。

[
  {
    "id": 1,: "学习 json-server",
    "status": "pending"
  },
  {
    "id": 2,: "写一篇关于 json-server 状态的文章",
    "status": "in-progress"
  },
  {
    "id": 3,: "发布文章",
    "status": "completed"
  }
]

你也可以通过 POST 请求创建新的待办事项，并在请求体中包含 status 字段：

{: "测试新任务",
  "status": "pending"
}

通过中间件动态添加或修改状态

我们可能希望在数据返回给客户端之前,动态地添加状态信息，或者根据某些规则修改状态。json-server 支持使用中间件来实现这一点。

示例场景： 我们希望所有新创建的 todos 在没有明确指定 status 时，默认状态为 pending。

操作步骤：

创建一个中间件文件,middleware.js：

// middleware.js
module.exports = (req, res, next) => {
  // 针对 POST /todos 请求
  if (req.method === 'POST' && req.path === '/todos') {
    // 如果请求体中没有 status 字段，则添加默认值
    if (!req.body.status) {
      req.body.status = 'pending';
    }
  }
  // 可以继续添加其他中间件逻辑
  next();
};

修改启动 json-server 的命令，引入中间件：

json-server --watch db.json --middleware middleware.js

验证：

如果你发送一个不带 status 字段的 POST 请求到 /todos：

{: "使用中间件添加默认状态"
}

json-server 会自动为你添加 status: "pending"：

{
  "id": 4,: "使用中间件添加默认状态",
  "status": "pending"
}

使用路由和自定义响应（进阶）

对于更复杂的状态逻辑,例如根据某些条件计算状态，或者返回一个包含状态描述的响应，你可以结合 json-server 的路由功能和自定义响应来实现，这通常涉及到编写一个更完整的 Node.js 脚本来启动 json-server，并利用其 router 和 middlewares。

示例场景： 我们希望返回的 todos 中，除了 status 字符串外，还有一个 status_display 字段，用于显示状态的中文描述。

操作步骤：

确保 db.json 中有 status 字段（如方法一）。
创建一个自定义服务器文件,server.js：

// server.js
const jsonServer = require('json-server');
const server = jsonServer.create();
const router = jsonServer.router('db.json');
const middlewares = jsonServer.defaults();
// 添加自定义中间件来修改响应
server.use((req, res, next) => {
  // 使用 json-server 的原始响应方法
  res.__jsonServerOriginalSend = res.send;
  res.send = (data) => {
    if (req.path.startsWith('/todos') && Array.isArray(data)) {
      data = data.map(item => {
        const statusMap = {
          'pending': '待办',
          'in-progress': '进行中',
          'completed': '已完成'
        };
        return {
          ...item,
          status_display: statusMap[item.status] || item.status
        };
      });
    } else if (req.path.startsWith('/todos') && data && typeof data === 'object') {
      // 处理单个资源的情况，如 GET /todos/1
      const statusMap = {
        'pending': '待办',
        'in-progress': '进行中',
        'completed': '已完成'
      };
      data = {
        ...data,
        status_display: statusMap[data.status] || data.status
      };
    }
    res.__jsonServerOriginalSend(data);
  };
  next();
});
server.use(middlewares);
server.use(router);
server.listen(3000, () => {
  console.log('JSON Server is running on port 3000');
});

通过 node server.js 启动服务。

验证：

访问 http://localhost:3000/todos，你会得到类似以下的响应：

[
  {
    "id": 1,: "学习 json-server",
    "status": "pending",
    "status_display": "待办"
  },
  {
    "id": 2,: "写一篇关于 json-server 状态的文章",
    "status": "in-progress",
    "status_display": "进行中"
  },
  {
    "id": 3,: "发布文章",
    "status": "completed",
    "status_display": "已完成"
  }
]

在 json-server 中添加状态字段非常灵活，具体选择哪种方法取决于你的需求：