如何在Swagger Editor中创建本地文件上传的multipart/form-data参数
解决Swagger Editor文件上传参数报错问题
你提供的代码缺少两个关键配置,导致Swagger Editor提示“需额外属性”,以下是修正方案:
修正后的Swagger 2.0代码
/upload: post: summary: Uploads a file. consumes: - multipart/form-data parameters: - in: formData name: upfile type: file required: true # 标记文件为必填,可根据需求改为false description: 待上传的本地文件 # 可选:添加参数描述,方便理解 responses: 200: description: 文件上传成功 schema: type: object properties: message: type: string 400: description: 文件无效或请求格式错误
错误原因&修正说明
- 缺少
required属性:Swagger 2.0规范对formData类型的参数,要求明确是否必填,添加该属性即可解决部分校验报错; - 缺少
responses字段:这是Swagger接口定义的强制要求,每个接口必须声明响应规则,否则会触发语法校验失败。
如果你用的是OpenAPI 3.0+规范
文件上传的写法和Swagger 2.0不同,给你对应代码参考:
/upload: post: summary: Uploads a file. requestBody: content: multipart/form-data: schema: type: object properties: upfile: type: string format: binary responses: 200: description: 文件上传成功 content: application/json: schema: type: object properties: message: type: string
内容的提问来源于stack exchange,提问作者Venkatesh
相关产品推荐
相关产品推荐

