1

我正在尝试为一些 REST API 调用创建一个招摇的文档。API 调用之一中的 POST 方法接受多部分表单数据内容,其中第一部分作为二进制文件数据,第二部分作为 json 实例。我正在寻找一种方法,允许访问 swagger ui 的用户仅为多部分表单数据内容的第一部分输入 Content-Disposition 标头和 Content-Range 标头的值。我试图在编码对象中使用标题对象但它并没有在 swagger-ui 中产生任何变化。我期望在请求正文中获取标头的参数字段,例如参数列表给出的请求标头参数。也许我错过了一些东西。如果这不是正确的方法,还有其他方法可以让我做到这一点吗?提前致谢。

这是带有请求正文的 swagger.json 的一部分:

{
    "requestBody": {
        "content": {
            "multipart/form-data": {
                "schema": {
                    "type": "object",
                    "properties": {
                        "file": {
                            "type": "string",
                            "format": "binary"
                        },
                        "instance": {
                            "type": "object",
                            "properties": {
                                "fileName": {
                                    "type": "string"
                                },
                                "fileType": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                "encoding": {
                    "file": {
                        "headers": {
                            "content-disposition": {
                                "schema": {
                                    "type": "string"
                                }
                            },
                            "content-range": {
                                 "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

预期结果:请求正文中每个标头的参数字段。

实际结果:swagger ui 中没有出现这样的参数字段。

4

0 回答 0