Nodejsでのインターフェースの戻り値の書き方

Node.js で RESTful API を作成する場合、ステータス コード、応答オブジェクト、およびオプションのメッセージを返すことでコントローラー アクションの戻り値を定義すると、API の使いやすさが向上し、API による正しい処理が向上します。クライアント。

Node.js インターフェースの戻り値の書き方

Node.js で制御用の RESTful API を書く場合演算子の操作の戻り値を定義することが重要です。正しい戻り値は、API の使いやすさを向上させるだけでなく、クライアントがリクエストを正しく処理するのにも役立ちます。

応答ステータス コードを決定する

まず、返される HTTP ステータス コードを決定します。一般的なステータス コードは次のとおりです。

• 200 OK: リクエストは成功しました。
• 201 Created: 新しいリソースが作成されました。
• 400 Bad Request: リクエストです。形式が間違っています
• 401 Unauthorized: Unauthorized
• 500 Internal Server Error: サーバーでエラーが発生しました

応答オブジェクトの作成

次に、応答を表す JavaScript オブジェクトを作成します。通常、このオブジェクトには次のプロパティが含まれます。

<code>{
  status: <HTTP 状态码>,
  data: <响应数据>,
  message: <可选消息>
}</code>

HTTP ステータス コードの設定

HTTP ステータス コードを status プロパティに割り当てます。

応答データの設定

応答データを data 属性に割り当てます。データには、文字列、オブジェクト、配列などの任意の JavaScript 値を指定できます。

オプションのメッセージの設定

必要に応じて、メッセージを message プロパティに割り当てることができます。メッセージは、応答に関する追加情報を提供します。

例

次は成功した応答の例です:

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

次はエラー応答の例です:

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

合格 これらの手順に従うことで、明確で有益な Node.js インターフェイスの戻り値を作成でき、API の全体的なエクスペリエンスが向上します。

以上がNodejsでのインターフェースの戻り値の書き方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。