邮递员：“无效的数据类型。必须是数组、布尔值、数字”错误

Question

在 Postman 中创建 API 时出现以下错误：“数据类型无效。必须是数组、布尔值、整数、数字、对象或字符串中的任何一个”

将"type": "file" 转换为"type": "object" 时，错误已修复，但我不确定是否有适合这种情况的方法。因为这次更新后，在 Postman 中发送请求时，请求可能无法通过。

"parameters": [
  {
      "in": "body",
      "name": "file",
      "description": "file",
      "required": false,
      "schema": {
          "type": "array",
          "items": {
              "type": "file"
          }
      }
  },
  ...
]

那么，我该如何解决 Postman 中的问题？

Answer 1

问题不在于 Postman，而在于 API 定义。 "type": "file" 不是用于架构和正文参数的有效类型值，此类型只能用于in: formData 参数。

另一方面，我在尝试通过 Postman 测试我的应用时没有添加文件。因此，我只想抑制错误

在这种情况下，您可以将 "type": "file" 更改为 "type": "string" 以抑制导入错误。或者从 API 定义中删除整个有问题的操作。

如何在 OpenAPI 中正确定义文件上传

API 定义试图描述文件数组的上传 - 但 OpenAPI 2.0 (swagger: '2.0') 不支持此功能。 OAS2 仅支持通过multipart/form-data 上传单个命名文件，在这种情况下，API 定义如下所示：

{
  "swagger: "2.0",
  ...

  "paths": {
    "/something": {
      "post": {
        "consumes": [
          "multipart/form-data"
        ],
        "parameters": [
          {
            "in": "formData",
            "name": "file1",
            "type": "file"    // A single file sent via form field "file1"
          },
          {
            "in": "formData",
            "name": "file2",
            "type": "file"    // Another file sent via form field "file2"
          }
        ]
        ...
}

上传文件数组是supported in OpenAPI 3：

{
  "openapi": "3.0.0",
  ...

  "paths": {
    "/something": {
      "post": {
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "binary"
                    }
                  }
                }
              }
            }
          }
        },
        ...

      }
    }
  }
}