我有一个图像上传端点,看起来像/test/{id}/relationships/image
。我想使用 OpenAPI 2.0 (Swagger 2.0) 来描述此端点。
端点具有路径和 formData 参数。我尝试了以下方法:
swagger: '2.0'
info:
title: API
version: 1.0.0
host: api.server.de
schemes:
- https
produces:
- application/json
paths:
'/test/{id}/relationships/image':
post:
operationId: addImage
consumes:
- multipart/form-data
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int32
- in: formData
name: file
type: file
required: true
description: The file to upload.
- in: formData
name: metadata
type: string
required: false
description: Description of file contents.
responses:
'202':
description: Uploaded
但 Swagger 编辑器显示错误:
架构错误位于
paths['/test/{id}/relationships/image'].post.parameters[0].in 应该
等于允许值 allowedValues 之一:body、header、
formData,查询跳转到第17行
架构错误位于
paths['/test/{id}/relationships/image'].post.parameters[0] 不应该
有附加属性additionalProperty:schema、in、name、
必填 跳转至第 17 行
我究竟做错了什么?
在您的路径参数中,更改
schema:
type: integer
format: int32
to
type: integer
format: int32
在 OpenAPI/Swagger 2.0 中,路径、标头、查询和 formData 参数使用type
直接,无需schema
. The schema
关键字仅用于主体参数。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)