在 Node.js 中编写 RESTful API 时，通过返回状态码、响应对象和可选消息来定义控制器操作的返回值，可以提高 API 的易用性和客户端的正确处理。

如何编写 Node.js 接口返回值

在 Node.js 中编写 RESTful API 时，为控制器操作定义返回值至关重要。正确的返回值不仅可以提高 API 的易用性，还可以帮助客户端正确处理请求。

确定响应状态码

首先，确定要返回的 HTTP 状态码。以下是一些常见状态码：

• 200 OK：请求成功
• 201 Created：创建了新资源
• 400 Bad Request：请求格式错误
• 401 Unauthorized：未经授权
• 500 Internal Server Error：服务器出现错误

创建响应对象

接下来，创建一个 JavaScript 对象来表示响应。此对象通常包括以下属性：

{
  status: <http>,
  data: ,
  message: 
}</http>

设置 HTTP 状态码

将 HTTP 状态码分配给 status 属性。

设置响应数据

Nodejs Patterns

内容：生产级 Node.js 后端模式，涵盖 Express/Fastify 配置、分层架构、中间件、错误处理、验证、数据库集成、身份验证及缓存。 时机：构建 REST API、搭建 Node.js 服务器、实施身份验证、集成数据库、添加验证/缓存或构建后端应用结构时。 关键词：nodejs, node, express, fastify, typescript, api, rest, 中间件, 身份验证, jwt, 验证, zod, postgres, mongodb, redis, 缓存, 速率限

下载

将响应数据分配给 data 属性。数据可以是任何 JavaScript 值，例如字符串、对象或数组。

设置可选消息

如果需要，可以将消息分配给 message 属性。消息提供有关响应的附加信息。

示例

以下是一个成功响应的示例：

res.status(200).json({
  data: {
    name: "John Doe",
    age: 30
  }
});

以下是一个错误响应的示例：

res.status(400).json({
  message: "Invalid request format"
});

通过遵循这些步骤，您可以编写清晰且信息丰富的 Node.js 接口返回值，从而改善您的 API 的整体体验。