如何测试NodeJS/Express开发的JSON:API接口响应合规性？

基础手动检查要点 #

在使用工具之前，可以先对照JSON:API核心规范做基础校验：

• 成功响应的顶层必须包含data字段（错误响应则为errors）
• 每个资源对象必须具备type和id必填字段
• 资源关联关系需嵌套在relationships字段中，关联的相关资源要放在included数组内
• 分页、过滤、排序的参数命名及响应格式需符合规范定义

在线测试工具 #

• JSON:API Validator：直接输入你的API接口URL，工具会自动拉取响应并按照JSON:API v1.0规范完成全量校验，返回具体的不合规细节（比如缺失必填字段、结构层级错误等）。
• Postman JSON:API 插件：在Postman中发送请求后，通过该插件一键校验响应结构是否符合规范，同时还能辅助生成符合规范的请求体，方便开发调试。

Node.js 离线测试工具 #

• jsonapi-validator库：可以集成到你的自动化测试用例中（比如Mocha、Jest），在测试环节自动校验API响应。示例代码：

const JsonApiValidator = require('jsonapi-validator').default;
const validator = new JsonApiValidator({ strict: true });

// 假设apiResponse是你从接口获取的响应对象
try {
  validator.validate(apiResponse);
  console.log('响应符合JSON:API规范');
} catch (err) {
  console.error('合规性问题：', err.message);
}

• express-jsonapi-validator中间件：针对Express框架的专属工具，直接挂载到路由中，就能自动校验请求和响应是否符合JSON:API规范，在开发阶段提前发现问题。示例代码：

const express = require('express');
const jsonapiValidator = require('express-jsonapi-validator');
const app = express();

// 挂载校验中间件
app.use(jsonapiValidator());

// 你的接口路由
app.get('/penalties/passeios', (req, res) => {
  // 处理请求并返回符合规范的响应
});

内容的提问来源于stack exchange，提问作者João Pimentel Ferreira