调用GET接口时提示'name'参数缺失的问题求助

DevOps 小满

2026-8-25

解决GET接口/v1/sites/:site_id/balise返回"Key 'name' required but not present."的问题

问题原因

错误由blueprintValidator.uriValidator中间件抛出，该中间件依据API Blueprint文档校验请求参数：

API文档中name参数未明确标记为可选，导致验证器将其判定为必填项
调用接口时未传递name查询参数，或传递方式不符合要求
控制器代码未提前处理name缺失的情况，且异常捕获写法有误（catch (next)无法正确传递错误）

解决方案

1. 正确传递`name`参数调用接口

在Postman中通过以下方式传递参数：

在Params标签下添加键为name、值为目标balise名称的参数
直接拼接URL：GET /v1/sites/[你的site_id]/balise?name=Balise2

2. 调整API文档定义（按需）

如果业务允许接口在无name参数时返回全部balise数据，修改文档将name标记为可选：

## Filter balises [/v1/sites/{site_id}/balise{?name}]

+ Parameters
  + site_id: `` (integer, required) ... id of the Site
  + name: `` (string, optional) ... Name of the balise to filter

修改后，blueprintValidator会允许不带name的请求通过校验。

3. 修复控制器代码逻辑

完善参数校验和异常处理：

const baliseName = req.query.name
// 新增参数校验，提前拦截缺失情况
if (!baliseName) {
  return next(new BadRequestError(req, res, 'Parameter "name" is required.'))
}
console.log(baliseName)
try {
  const balise = await Balise.getByName(baliseName)

  if (!balise) {
    return next(new ResourceNotFoundError(req, res, 'No balise found for this name.'))
  }
  res.locals.data = balise
  next()
} catch (err) {
  // 正确传递捕获到的异常
  next(err)
}