nodejsとexpressで作成されたREST APIで応答ステータスとJSONコンテンツを設定する適切な方法

Nodejsをいじって、小さなREST APIを作成して表現しています。私の質問は、コードのステータスと応答データを設定するための良い方法/最良の方法は何ですか？

少しのコードで説明しましょう（サーバーを起動するために必要なノードとエクスプレスコードは記述しません。関係するルーターメソッドのみです）：

router.get('/users/:id', function(req, res, next) {
  var user = users.getUserById(req.params.id);
  res.json(user);
});


exports.getUserById = function(id) {
  for (var i = 0; i < users.length; i++) {
    if (users[i].id == id) return users[i];
  }
};

以下のコードは完全に機能し、Postmanでリクエストを送信すると、次の結果が得られます。

ご覧のように、ステータスは200で、これは問題ありません。しかし、これはこれを行うための最良の方法ですか？返されたJSONだけでなく、自分でステータスを設定する必要がある場合はありますか？それとも、常にExpressによって処理されますか？

たとえば、簡単なテストを行い、上記のgetメソッドをわずかに変更しました。

router.get('/users/:id', function(req, res, next) {
  var user = users.getUserById(req.params.id);
  if (user == null || user == 'undefined') {
    res.status(404);
  }
  res.json(user);
});

ご覧のとおり、ユーザーが配列に見つからない場合は、ステータスを404に設定します。

このトピックの詳細を学ぶためのリソース/アドバイスは大歓迎です。

Express APIリファレンスはこのケースをカバーしています。

ステータスを確認して送信してください。

つまり、またはをstatus呼び出す前にメソッドを呼び出すjson必要がありsendます。

res.status(500).send({ error: "boo:(" });

あなたはこのようにすることができます：

res.status(400).json(json_response);

これにより、HTTPステータスコードが400に設定され、Express 4でも機能します。

使用する際に200の状態がデフォルトになりますres.send、res.jsonなど

次のようにステータスを設定できます res.status(500).json({ error: 'something is wrong' });

しばしば私は次のようなことをします...

router.get('/something', function(req, res, next) {
  // Some stuff here
  if(err) {
    res.status(500);
    return next(err);
  }
  // More stuff here
});

次に、エラーミドルウェアに応答を送信させ、エラーが発生した場合に必要な他のことを実行します。

追加：res.sendStatus(status)バージョン4.9.0の 時点で追加されましたhttp://expressjs.com/4x/api.html#res.sendStatus

HTTPステータスコードのリスト

ステータス応答に関する推奨事項は、予測どおり、エラーに応じて適切なHTTPステータスコード（クライアントエラーの場合は4xx、サーバーエラーの場合は5xx）を送信することです。実際のJSON応答に関しては、「聖書」はありませんが、成功した応答でルートオブジェクトの2つの異なるプロパティとして（再び）ステータスとデータを送信する（これにより、クライアントはHTTPヘッダーとペイロード自体からステータスをキャプチャする機会が与えられます）と、エラーの場合、人間が理解できる方法でエラー。

Stripeの APIは、現実の世界でも同様に動作します。

すなわち

OK

200, {status: 200, data: [...]}

エラー

400, {status: 400, data: null, message: "You must send foo and bar to baz..."}

私はこれをExpress.jsアプリケーションで使用しています：

app.get('/', function (req, res) {
    res.status(200).json({
        message: 'Welcome to the project-name api'
    });
});

以下のプロパティを含む完全なHttpResponseを取得する標準的な方法

1. body //データが含まれています
2. ヘッダー
3. OK
4. 状態
5. statusText
6. タイプ
7. url

上のバックエンド、これを行います

router.post('/signup', (req, res, next) => {
    // res object have its own statusMessage property so utilize this
    res.statusText = 'Your have signed-up succesfully'
    return res.status(200).send('You are doing a great job')
})

上のフロントエンドなどでAngular、単に実行します。

let url = `http://example.com/signup`
this.http.post(url, { profile: data }, {
    observe: 'response' // remember to add this, you'll get pure HttpResponse
}).subscribe(response => {
    console.log(response)
})

res.status(500).jsonp(dataRes);

try {
  var data = {foo: "bar"};
  res.json(JSON.stringify(data));
}
catch (e) {
  res.status(500).json(JSON.stringify(e));
}

あなたはこれを行うことができます

            return res.status(201).json({
                statusCode: req.statusCode,
                method: req.method,
                message: 'Question has been added'
            });

エラー応答を送信する最良の方法はreturn res.status(400).send({ message: 'An error has occurred' })です。

次に、フロントエンドで、次のようなものを使用してそれをキャッチできます。

        url: your_url,
        method: 'POST',
        headers: headers,
        data: JSON.stringify(body),
    })
        .then((res) => {
            console.log('success', res);
        })
        .catch((err) => {
            err.response && err.response.data && this.setState({ apiResponse: err.response.data })
        })

err送信したメッセージオブジェクトはに存在するため、ログを記録するだけでは機能しませんerr.response.data。

お役に立てば幸いです。