打开api错误：请求应该具有必需的属性“. Headers”-docker

Question

我的nodejs应用程序有一个开放api。yaml文件和ExpressOpenAPI验证验证器。我正在做一个POST请求，它正在工作，api验证程序没有返回任何错误：

curl --request POST 'http://localhost:33004/my-app/settings' --data-raw '{"serials":["1234","2355"]}' -H 'Content-Type: application/json'

在我的open-api.yaml中，我有:

openapi: '3.0.0'
servers:
 - url: 'http://{host}/my-app'
   variables:
     host:
     enum:
       - 'localhost'
       ....
...
paths:
    /settings:
      ...
      post:
        tags:
          - 'settings'
        operationId: 'postSettings'
        requestBody:
          content:
            application/json:
              schema:
                type: object
                properties:
                  serials:
                    type: array
                    items:
                      type: string
...

然后我尝试对我的应用程序进行dockerized-创建了一个docker容器，并在pm2-runtime中运行它。但是，当应用程序在docker容器中运行时，我向它发送相同的请求时，在验证请求时出现了错误：请求应该具有必需的属性“. Headers”。我没有在open-api.yaml文件中提到的属性“. Headers”。

我尝试删除验证器中间件，请求顺利通过。你能帮我理解验证器在抱怨什么吗？

编辑：

我设法找到了错误对象:

{
  "data": [
    {
      "dataPath": "",
      "keyword": "required",
      "message": "should have required property '.headers'",
      "params": {
        "missingProperty": ".headers"
      },
      "schemaPath": "#/required"
    }
  ],
  "name": "ValidationError",
  "statusCode": 400
}

不用说，我没有必要的headers属性。。。

Answer 1

如果其他人因为这个问题来到这里，以供将来参考：

我终于发现了问题：我在我的 Dockerfile 中使用了 FROM 节点：高山，这表示节点的最新版本。但是，我的应用程序在节点 10.18.1 上运行

一旦我更改为From： node： 10.18.1-alpine，问题就解决了。

显然，express-openapi-validate插件在最新的节点模块中有一些问题，或者看起来是这样。

Answer 2

可能有点晚，但希望对其他人有用。

问题与此代码有关（这是编译版本）

...
const reqToValidate = Object.assign({}, req, { cookies: req.cookies
                    ? Object.assign({}, req.cookies, req.signedCookies) : undefined });
const valid = validator(reqToValidate);
...

在 OpenApi 验证码上，以及 Express req 对象使用访问器获取/设置标头的事实，结果 Object.assign 不会传播标头信息，并且验证程序函数不会找到所需的标头属性，只有 rawHeader 可用。

作为快速修复，我实现了以下内容：

const validator = this.openApiValidator.validate(method, path);
return (req, res, next) => {
    const reqToValidate = Object.assign({}, req, {
        cookies: req.cookies
            ? Object.assign({}, req.cookies, req.signedCookies) : undefined
    });
   
    if (!reqToValidate.hasOwnProperty('headers')) {
        reqToValidate.headers = req.headers;
    }
    return validator(reqToValidate, res, next);
};

其适应快速请求并传播关于报头的所有所需信息。

Answer 3

我对所有节点版本都有相同的

不可能让验证器与节点版本16一起工作，因此我们被困在旧的开发版本上。

解决方案是迁移到ExpressOpenAPI验证程序v4。

此处解释了迁移https://github . com/cdimascio/express-open API-validator # upgrading-from-3x

这（v3）：

const validator = new OpenApiValidator({
  apiSpec: openApiYaml,
  operationHandlers: __dirname
})
app.use(validator)

变成(v4):

const validator = OpenApiValidator.middleware({
  apiSpec: 'src/openapi.yaml'
})
app.use(validator)

代码最初是由https://hub.docker.com/r/openapitools/openapi-generator-cli生成的