如何在Node.js的Express接口中读取YAML请求体并兼容JSON

1. 安装依赖 #

首先确保项目中已安装js-yaml，用于解析YAML内容：

npm install js-yaml
# 或使用yarn
yarn add js-yaml

2. 编写YAML解析中间件 #

Express默认仅处理JSON请求体，我们需要自定义中间件识别YAML类型请求并完成解析：

const jsYaml = require('js-yaml');

function yamlParser(req, res, next) {
  // 匹配常见的YAML内容类型
  const isYaml = req.is('application/yaml') || req.is('text/yaml') || req.is('application/x-yaml');
  if (!isYaml) {
    return next(); // 非YAML请求，交给后续中间件处理
  }

  let rawBody = '';
  // 读取请求体内容
  req.on('data', chunk => {
    rawBody += chunk.toString();
  });

  req.on('end', () => {
    try {
      // 将YAML解析为JS对象，挂载到req.body上
      req.body = jsYaml.load(rawBody);
      next();
    } catch (err) {
      // 解析失败返回400错误
      res.status(400).json({ error: '无效的YAML格式', details: err.message });
    }
  });
}

3. 在Express应用中启用中间件 #

将自定义YAML中间件放在路由之前，同时保留原有的JSON解析中间件，让API同时支持JSON和YAML请求：

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

// 先加载YAML解析中间件
app.use(yamlParser);
// 保留JSON解析，兼容原有请求
app.use(express.json());

// 示例路由，现在可接收YAML或JSON请求体
app.post('/api/submit', (req, res) => {
  console.log('接收到的请求体:', req.body);
  res.status(200).json({ success: true, data: req.body });
});

app.listen(3000, () => {
  console.log('服务运行在端口3000');
});

4. 测试YAML请求 #

发送请求时，需将请求头的Content-Type设置为application/yaml（或text/yaml），请求体使用YAML格式，例如：

title: 测试YAML请求
content: 这是一段YAML格式的请求内容
metadata:
  author: test
  timestamp: 2024-05-20

注意事项 #

• 中间件顺序：YAML解析中间件要放在express.json()之前，避免请求体被提前消费。
• 错误处理：务必捕获YAML解析异常，返回明确错误信息，防止服务崩溃。
• 内容类型扩展：若需支持其他YAML相关Content-Type，可在isYaml判断中添加对应类型。

内容的提问来源于stack exchange，提问作者mnvbrtn