Node.js项目PUT更新接口Postman调用正常但Swagger请求报错如何解决

1. 优先修复Swagger配置错误（核心原因，Postman调用正常说明接口逻辑本身无问题，错误来自Swagger参数解析规则不匹配） #

你当前的Swagger配置存在3处明显错误：

• 路径参数名不匹配：Express接口定义的路径参数为id（小写），但Swagger配置中路径参数的name字段写为Id（大写），Swagger会按照配置的字段名拼接路径，导致后端无法正确获取req.params.id
• Body参数配置语法错误：Swagger规范中body参数的模型引用直接使用schema字段即可，不需要加$schema前缀
• 模型引用路径拼写错误：你写的#/definations/User拼写错误，正确的内置模型路径为#/definitions/User

修正后的Swagger配置如下：

"/user/update/{id}": {
    "put": {
        "tags": [
            "Update-Api"
        ],
        "summary": "Update-user",
        "description": "To update the particular user",
        "operationId": "updateUser",
        "consumes": ["application/json"],
        "parameters":[
            {
                "name":"id",
                "in":"path",
                "description":"enter the id of the user",
                "required":true,
                "type":"string"
            },
            {
                "name":"body",
                "in":"body",
                "description":"Enter the update value",
                "required":true,
                "schema": {
                    "$ref": "#/definitions/User"
                }
            }
        ],
        "responses": {
            "200": {
                "description": "Update successful"
            },
            "400": {
                "description": "Invalid user supplied"
            },
            "404": {
                "description": "User not found"
            }
        }
    }
}

2. 补全接口代码的异常判断（避免隐藏真实报错） #

当前接口代码没有对查询结果做非空判断，且catch块没有打印错误日志，无法定位真实报错原因，修正后代码如下：

export let updateUser = async(req: Request, resp: Response) => {
        try{
            // 调试阶段打印参数，确认Swagger传参是否正确，调试完成可删除
            console.log('路径参数：', req.params.id, '请求体参数：', req.body)
            const use = await User.findById(req.params.id);
            // 新增非空判断，避免查询结果为空时报错
            if (!use) {
                return resp.status(404).send('User not found')
            }
            use.name = req.body.name;
            // use.email = req.body.email;

            const a1 = await use.save();
            resp.json("successfully updated");

        } catch(err) {
            // 打印错误日志方便定位问题
            console.error('更新接口报错：', err)
            resp.status(500).send('Error: ' + err.message)
        }
}

3. 验证步骤 #

• 修复配置后重启服务，打开Swagger页面确认接口参数表单正常展示User模型的对应字段
• 填写正确的用户id和name字段发起请求，查看控制台打印的参数是否和输入一致
• 若仍有报错，根据控制台打印的具体错误信息对应处理即可

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