在用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];
  }
};

下面的代码工作完美，当发送一个请求与邮差，我得到以下结果:

如您所见，状态显示为200，这是正常的。但这是最好的方法吗?是否有一种情况下，我应该设置自己的状态，以及返回的JSON?还是特快专递?

例如，我只是做了一个快速测试，并稍微修改了上面的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状态。

更多关于这个主题的资源/建议是非常欢迎的。

当前回答

我没有看到任何人提到的事实，方法调用的顺序对res对象是重要的。我是nodejs的新手，一开始并没有意识到res.json()不仅仅是设置响应的主体。它实际上也试图推断响应状态。所以，如果像这样做:

res.json({"message": "Bad parameters"})
res.status(400)

第二行是没有用的，因为基于正确构建的json, express/nodejs已经推断出了成功状态(200)。

2020-12-02 15:10:13

其他回答

对于 IIS

如果您正在使用iisnode通过IIS运行nodejs，请记住，IIS默认会替换您发送的任何错误消息。

这意味着如果您发送res.status(401)。你没有权限查看这个目录或页面。json({消息:"不正确的授权令牌"})

可以通过向web添加以下代码来关闭此行为。<system. Config文件。网络服务器>(来源):

2020-07-31 17:44:23

你可以这样做:

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

这将把HTTP状态代码设置为400，即使在express 4中也能工作。

2016-06-03 20:13:58

你可以这样做

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

2020-03-13 06:54:21

我在我的Express.js应用程序中使用这个:

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

2016-10-28 12:13:28

快速API参考涵盖了这种情况。

查看状态并发送。

简而言之，你只需要在调用json或send之前调用status方法:

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

2014-09-26 19:29:24

在用nodejs和express创建的REST API中设置响应状态和JSON内容的正确方法

推荐文章

最新文章

标签