表達自定義 json 響應

Question

我想在最后對每個請求發送自定義 json 響應，例如：

{
  "message": "Something",
  "type": "success",
  "payload": /*object, array, anything else */
}

我能做的是在每個請求使用結束時：

res.status(200).json({message: 'Something', type: 'success', payload});

如果出於某種原因我希望我的回復有另一種格式，我必須去更改每個 res.json，這很糟糕。

但是因為我知道我的所有響應都將具有這種格式，有沒有辦法創建一個中間件並傳遞一些變量，如有效負載、消息、在每個請求結束時執行的類型？

Answer 1

可以為響應創建一個中間件

router.get('/some-route', controller.someFunction, resposeMiddleware)

您需要在下一次調用時將響應作為參數傳遞

someFunction (req, res, next) => {
    res.local.payload = {/* some data */}
    next()
}

resposeMiddleware 將是這樣的

const resposeMiddleware = (req, res) => {
      const { payload } =  res.local
      res.status(200).json({message: 'Something', type: 'success', payload})
}

Answer 2

創建一個像 bellow (successResponse.js) 這樣的輔助方法。 您還可以將任何屬性設置為默認值。

    successResponse = (res, statusCode, message, data) => {
      res.status(statusCode || 200).json({
      code: statusCode || 200,
      message: message || "success",
      data: data || {},
    });
   };

   module.exports = successResponse;

現在在您的控制器中只需導入 successResponse 並使用它

successResponse(res, 200, "Your Success message", data);