在swagger-3.0的多部分请求主体下,swagger-ui中是否有用于特定表单数据内容的内容标头的参数字段?

时间:2019-01-28 10:55:50

标签: swagger multipartform-data swagger-ui swagger-editor swagger-3.0

我正在尝试为一些REST API调用创建详尽的文档。其中一个API调用中的POST方法接受多部分形式的数据内容,其中第一部分为二进制文件数据,第二部分为json实例。我正在寻找一种方法,允许访问swagger ui的用户仅输入多部分表单数据内容的第一部分的Content-Disposition标头和Content-Range标头的值。我尝试在Header Object内使用Encoding Object,但未在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中没有出现这样的参数字段。

0 个答案:

没有答案