如何在OpenAPI中指定多文件上传？

Question

我试图从我的代码库生成数据来填充OpenAPI 3.0输入。

我有一个restendpoint，用于将文件上载到服务器。

我有一个表单作为聚合vaadin上传组件，用于上传文件。路径是/upload all，表单参数名是my attachment。表单正确地将文件上传到服务器，所以这不是问题所在。

服务器endpoint使用超文本标记语言窗体规范中的XQRS RestXQ上传文件来实现。

我正在尝试为多部分文件上传的OpenAPI 3.0UI创建一个OpenAPI JSON输入。以下是我尝试过的：

"/upload-all": {
    "post": {
        "consumes": ["multipart/form-data"],
        "description": "Upload zip file to the server",
        "responses": {
            "content": {
                "application/json": {
                    "schema": {
                        "type": "object"
                    }
                }
            }
        },
        "parameters": [
            {
                "in": "formData",
                "schema": {
                    "type": "array",
                    "items": {
                        "type": "file"
                    }
                },
                "name": "my-attachment"
            }
        ]
    }
},

我收到一个错误，表单参数my attachment没有被填充。我错过了什么？我还没有在OpenAPI网站上找到一个明确的规范。

更新：我尝试将代码的输出更改为：

"/upload-all": {
    "post": {
        "requestBody": {
            "content": {
                "multipart/form-data": {
                    "schema": {
                        "properties": {
                            "my-attachment": {
                                "type": "array",
                                "items": {
                                    "format": "binary",
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "description": "Upload zip file to the server",
        "responses": {
            "content": {
                "application/json": {
                    "schema": {
                        "type": "object"
                    }
                }
            }
        }
    }
},

OpenAPI UI显示了以下内容：

应该是这样的：

OpenAPI用户界面是最新的。这里少了什么？

Answer 1

您就快到了-只需将"type"："object"添加到您的请求正文架构中：

        "requestBody": {
            "content": {
                "multipart/form-data": {
                    "schema": {
                        "type": "object",   // <-------
                        "properties": {
                            "my-attachment": {
                                ...

确保您使用的是3.25.3版或更高版本的Swigger UI。早期版本不支持多文件上传。