json - 使用节点或 Express 返回 JSON 的正确方法

Question

因此，可以尝试获取以下 JSON 对象：

$ curl -i -X GET http://echo.jsontest.com/key/value/anotherKey/anotherValue
HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=ISO-8859-1
Date: Wed, 30 Oct 2013 22:19:10 GMT
Server: Google Frontend
Cache-Control: private
Alternate-Protocol: 80:quic,80:quic
Transfer-Encoding: chunked

{
   "anotherKey": "anotherValue",
   "key": "value"
}
$

有没有办法使用 node 或 express 在服务器的响应中生成完全相同的主体？显然，可以设置标头并指示响应的内容类型将是“application/json”，但是写入/发送对象有不同的方法。我见过的常用命令是使用以下形式的命令：

response.write(JSON.stringify(anObject));

但是，这有两点可以争论，就好像它们是“问题”一样：

我们正在发送一个字符串。
而且，最后没有换行符。

另一个想法是使用命令：

response.send(anObject);

这似乎是基于 curl 的输出发送一个 JSON 对象，类似于上面的第一个示例。但是，当 curl 再次在终端上使用时，正文末尾没有换行符。那么，如何使用 node 或 node/express 在末尾附加一个换行符来实际写下这样的内容？

score 744 · Accepted Answer

该响应也是一个字符串，如果您想发送经过美化的响应，出于某种尴尬的原因，您可以使用类似JSON.stringify(anObject, null, 3)

将Content-Type标题设置为application/json也很重要。

var http = require('http');

var app = http.createServer(function(req,res){
    res.setHeader('Content-Type', 'application/json');
    res.end(JSON.stringify({ a: 1 }));
});
app.listen(3000);

// > {"a":1}

美化：

var http = require('http');

var app = http.createServer(function(req,res){
    res.setHeader('Content-Type', 'application/json');
    res.end(JSON.stringify({ a: 1 }, null, 3));
});
app.listen(3000);

// >  {
// >     "a": 1
// >  }

我不确定你为什么要用换行符来终止它，但你可以JSON.stringify(...) + '\n'做到这一点。

表达

在 express 中，您可以通过更改选项来做到这一点。

'json replacer'JSON替换回调，默认为null

'json spaces'用于格式化的 JSON 响应空间，在开发中默认为 2，在生产中默认为 0

实际上不建议设置为 40

app.set('json spaces', 40);

然后你可以用一些 json 来回应。

res.json({ a: 1 });

它将使用'json spaces' 配置来美化它。

score 460 · Accepted Answer

由于 Express.js 3x 响应对象有一个 json() 方法，该方法为您正确设置所有标头并返回 JSON 格式的响应。

例子：

res.json({"foo": "bar"});

score 26 · Accepted Answer

如果你使用 Express，你可以使用这个：

res.setHeader('Content-Type', 'application/json');
res.send(JSON.stringify({key:"value"}));

或者只是这个

res.json({key:"value"});

score 22 · Accepted Answer

对于大多数情况，该res.json()功能应该足够了。

app.get('/', (req, res) => res.json({ answer: 42 }));

该res.json()函数使用将您传递的参数转换为 JSONJSON.stringify()并将标头设置Content-Type为application/json; charset=utf-8以便 HTTP 客户端知道自动解析响应。

score 20 · Accepted Answer

如果您尝试发送 json 文件，您可以使用流

var fs = require('fs');

var usersFilePath = path.join(__dirname, 'users.min.json');

apiRouter.get('/users', function(req, res){
    var readable = fs.createReadStream(usersFilePath);
    readable.pipe(res);
});

score 8 · Accepted Answer

您可以为此制作一个助手：制作一个助手函数，以便您可以在应用程序的任何地方使用它

function getStandardResponse(status,message,data){
    return {
        status: status,
        message : message,
        data : data
     }
}

这是我试图获取所有主题的主题路线

router.get('/', async (req, res) => {
    const topics = await Topic.find().sort('name');
    return res.json(getStandardResponse(true, "", topics));
});

我们得到的回应

{
"status": true,
"message": "",
"data": [
    {
        "description": "sqswqswqs",
        "timestamp": "2019-11-29T12:46:21.633Z",
        "_id": "5de1131d8f7be5395080f7b9",
        "name": "topics test xqxq",
        "thumbnail": "waterfall-or-agile-inforgraphics-thumbnail-1575031579309.jpg",
        "category_id": "5de0fe0b4f76c22ebce2b70a",
        "__v": 0
    },
    {
        "description": "sqswqswqs",
        "timestamp": "2019-11-29T12:50:35.627Z",
        "_id": "5de1141bc902041b58377218",
        "name": "topics test xqxq",
        "thumbnail": "waterfall-or-agile-inforgraphics-thumbnail-1575031835605.jpg",
        "category_id": "5de0fe0b4f76c22ebce2b70a",
        "__v": 0
    },
    {
        "description": " ",
        "timestamp": "2019-11-30T06:51:18.936Z",
        "_id": "5de211665c3f2c26c00fe64f",
        "name": "topics test xqxq",
        "thumbnail": "waterfall-or-agile-inforgraphics-thumbnail-1575096678917.jpg",
        "category_id": "5de0fe0b4f76c22ebce2b70a",
        "__v": 0
    },
    {
        "description": "null",
        "timestamp": "2019-11-30T06:51:41.060Z",
        "_id": "5de2117d5c3f2c26c00fe650",
        "name": "topics test xqxq",
        "thumbnail": "waterfall-or-agile-inforgraphics-thumbnail-1575096701051.jpg",
        "category_id": "5de0fe0b4f76c22ebce2b70a",
        "__v": 0
    },
    {
        "description": "swqdwqd wwwwdwq",
        "timestamp": "2019-11-30T07:05:22.398Z",
        "_id": "5de214b2964be62d78358f87",
        "name": "topics test xqxq",
        "thumbnail": "waterfall-or-agile-inforgraphics-thumbnail-1575097522372.jpg",
        "category_id": "5de0fe0b4f76c22ebce2b70a",
        "__v": 0
    },
    {
        "description": "swqdwqd wwwwdwq",
        "timestamp": "2019-11-30T07:36:48.894Z",
        "_id": "5de21c1006f2b81790276f6a",
        "name": "topics test xqxq",
        "thumbnail": "waterfall-or-agile-inforgraphics-thumbnail-1575099408870.jpg",
        "category_id": "5de0fe0b4f76c22ebce2b70a",
        "__v": 0
    }
      ]
}

score 5 · Accepted Answer

您可以使用管道和众多处理器之一来美化它。您的应用程序应始终以尽可能小的负载响应。

$ curl -i -X GET http://echo.jsontest.com/key/value/anotherKey/anotherValue | underscore print

https://github.com/ddopson/underscore-cli

score 4 · Accepted Answer

您可以使用中间件设置默认 Content-Type，并为特定 API 设置不同的 Content-Type。这是一个例子：

const express = require('express');
const app = express();

const port = process.env.PORT || 3000;

const server = app.listen(port);

server.timeout = 1000 * 60 * 10; // 10 minutes

// Use middleware to set the default Content-Type
app.use(function (req, res, next) {
    res.header('Content-Type', 'application/json');
    next();
});

app.get('/api/endpoint1', (req, res) => {
    res.send(JSON.stringify({value: 1}));
})

app.get('/api/endpoint2', (req, res) => {
    // Set Content-Type differently for this particular API
    res.set({'Content-Type': 'application/xml'});
    res.send(`<note>
        <to>Tove</to>
        <from>Jani</from>
        <heading>Reminder</heading>
        <body>Don't forget me this weekend!</body>
        </note>`);
})

score 4 · Accepted Answer

对于问题的标题部分，我要在res.type这里大声喊叫：

res.type('json')

相当于

res.setHeader('Content-Type', 'application/json')

资料来源：快递文档：

将 Content-Type HTTP 标头设置为 mime.lookup() 为指定类型确定的 MIME 类型。如果 type 包含“/”字符，那么它将 Content-Type 设置为 type。

score 3 · Accepted Answer

旧版本的 Express 使用app.use(express.json())或bodyParser.json() 阅读有关 bodyParser 中间件的更多信息

在最新版本的 express 上，我们可以简单地使用res.json()

const express = require('express'),
    port = process.env.port || 3000,
    app = express()

app.get('/', (req, res) => res.json({key: "value"}))

app.listen(port, () => console.log(`Server start at ${port}`))

json - 使用节点或 Express 返回 JSON 的正确方法

10 回答 10

表达

Related

Reference