基于OpenAPI生成器的前后端自定义错误响应丢失问题求助

我们用OpenAPI生成器开发前后端项目，当传入无效输入时，后端返回带自定义错误信息的406响应（单纯HTTP状态码不够满足业务反馈需求），但前端捕获的error对象里拿不到自定义内容。Network面板能看到正确的响应体{"message": "InvalidLicense"}，但前端console.log(error)输出里看不到这些关键信息。

相关代码片段 #

OpenAPI（Swagger）定义 #

responses:
  '200':
    description: OK
  '406':
    description: Not Acceptable
    content:
      application/json:
        schema:
          type: object
          title: ErrorResponseBody
          properties:
            message:
              type: string
          required:
            - message

后端代码示例 #

@app.put("/examplesnippet")
def examplesnippet():
    ...
    try:
        ...
    except RuntimeError as e:
        return ErrorResponseBody(str(e)).to_dict(), 406
    return {}, 200

前端调用代码 #

new AccountApi(getApiConfiguration())
  .putAccountLicense({updateLicenseRequestBody: {licenseKey: newLicenseCode}})
  .then(response => {
    ...
  })
  .catch(error => {
    console.log(error);
    ...
  });

解决步骤 #

1. 调整OpenAPI生成器配置 #

生成前端客户端时，必须启用错误响应解析功能。如果用openapi-generator-cli生成，添加对应参数：

openapi-generator-cli generate -g javascript -i openapi.yaml -o src/api --enable-post-process-file

不同语言的生成器参数略有差异，比如TypeScript生成器可设置withErrorHandling: true，确保客户端能识别并解析错误状态码对应的响应体。

2. 修正前端错误捕获逻辑 #

OpenAPI生成的客户端不会把自定义错误直接挂在error对象顶层，而是放在error.response属性里。修改捕获代码：

.catch(error => {
  if (error.response) {
    // 提取后端返回的自定义错误内容
    const errorBody = error.response.data;
    console.log('错误信息:', errorBody.message); // 这里就能拿到"InvalidLicense"
  } else {
    // 处理网络类错误
    console.log('请求异常:', error.message);
  }
});

3. 校验OpenAPI定义的正确性 #

• 确保ErrorResponseBody的Schema定义完整，和后端返回的结构完全匹配；如果是通过$ref引用，要确认components/schemas里的定义正确。
• 后端返回响应时，必须设置Content-Type: application/json，和OpenAPI里的content配置一致，否则生成的客户端会跳过响应体解析。

4. 检查生成的客户端代码 #

打开生成的API客户端文件（比如AccountApi.js），查看putAccountLicense方法的实现，确认代码里包含对406响应的处理逻辑，能够将响应体解析为对应的错误对象结构。

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