如何編寫 Node.js 接口返回值

在 Node.js 中編寫 RESTful API 時，為控制器操作定義返回值至關(guān)重要。正確的返回值不僅可以提高 API 的易用性，還可以幫助客戶端正確處理請求。

確定響應(yīng)狀態(tài)碼

首先，確定要返回的 HTTP 狀態(tài)碼。以下是一些常見狀態(tài)碼：

200 OK：請求成功
201 Created：創(chuàng)建了新資源
400 Bad Request：請求格式錯誤
401 Unauthorized：未經(jīng)授權(quán)
500 Internal Server Error：服務(wù)器出現(xiàn)錯誤

創(chuàng)建響應(yīng)對象

接下來，創(chuàng)建一個 JavaScript 對象來表示響應(yīng)。此對象通常包括以下屬性：

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

設(shè)置 HTTP 狀態(tài)碼

將 HTTP 狀態(tài)碼分配給 屬性。

設(shè)置響應(yīng)數(shù)據(jù)

將響應(yīng)數(shù)據(jù)分配給 屬性。數(shù)據(jù)可以是任何 JavaScript 值，例如字符串、對象或數(shù)組。

設(shè)置可選消息

如果需要，可以將消息分配給 屬性。消息提供有關(guān)響應(yīng)的附加信息。

示例

以下是一個成功響應(yīng)的示例：

<code class="javascript">res.status(200).json({
  data: {
    name: "John Doe",
    age: 30
  }
});</code>

以下是一個錯誤響應(yīng)的示例：

<code class="javascript">res.status(400).json({
  message: "Invalid request format"
});</code>

通過遵循這些步驟，您可以編寫清晰且信息豐富的 Node.js 接口返回值，從而改善您的 API 的整體體驗。